You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Visual Studio Code Remote - Containers extension lets you use a Docker container as a full-featured development environment. It allows you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set. A [devcontainer.json](https://code.visualstudio.com/docs/remote/containers#_create-a-devcontainerjson-file) file in your project tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack. This container can be used to run an application or to separate tools, libraries, or runtimes needed for working with a codebase.
4
+
5
+
If you open the project in VSCode, you can reopen the folder in the development container and have a full working environment.
This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
10
10
repository to generate the file structure for a Python project that uses
11
-
[Poetry](https://python-poetry.org/) for its dependency management.
11
+
[Poetry](https://python-poetry.org/) for its dependency management.
12
12
13
-
A project generated with ``cookiecutter-poetry`` supports the following features:
13
+
A project generated with ``cookiecutter-pypackage`` supports the following features:
14
14
15
15
-[Poetry](https://python-poetry.org/), obviously.
16
16
- CI/CD with [GitHub Actions](https://github.com/features/actions)
17
17
- Formatting with [black](https://pypi.org/project/black/) and [isort](https://pycqa.github.io/isort/index.html)
18
18
- Linting with [flake8](https://flake8.pycqa.org/en/latest/)
19
-
- Publishing to [Pypi](https://pypi.org)or [Artifactory](https://jfrog.com/artifactory)by creating a new release on GitHub
19
+
- Publishing to [Pypi](https://pypi.org) by creating a new release on GitHub
20
20
- Testing with [pytest](https://docs.pytest.org/en/7.1.x/)
21
21
- Documentation with [MkDocs](https://www.mkdocs.org/)
22
22
- Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
23
23
- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)
24
24
- Containerization with [Docker](https://www.docker.com/)
25
+
-[Developing inside a Container in VSCode](https://code.visualstudio.com/docs/remote/containers)
25
26
26
-
An example of a repository generated with this package can be found [here](https://github.com/{{cookiecutter.author_github_handle}}/cookiecutter-poetry-example).
27
+
An example of a repository generated with this package can be found [here](https://github.com/{{cookiecutter.author_github_handle}}/cookiecutter-pypackage-example).
27
28
28
29
## Quickstart
29
30
30
31
On your local machine, navigate to the directory in which you want to
31
32
create a project directory, and run the following two commands:
32
33
33
34
```bash
34
-
pip install cookiecutter-poetry
35
+
pip install cookiecutter-pypackage
35
36
ccp
36
37
```
37
38
@@ -40,7 +41,7 @@ Github repository to the `cookiecutter` command:
Then run the following commands, replacing `<project-name>`, with the
@@ -58,13 +59,13 @@ git push -u origin main
58
59
59
60
Finally, install the environment with `make install`.
60
61
61
-
You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
62
+
You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
62
63
63
-
To finalize the set-up for publishing to PyPi or Artifactory, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github).
64
+
To finalize the set-up for publishing to PyPi, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github).
64
65
65
66
## Acknowledgements
66
67
67
68
This project is partially based on [Audrey
68
69
Feldroy's](https://github.com/audreyfeldroy) great
69
70
[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) and [
70
-
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-poetry).
71
+
Florian Maas](https://github.com/fpgmaas/) great [cookiecutter-pypackage](https://github.com/fpgmaas/cookiecutter-pypackage).
0 commit comments