bootstrapit update

This commit is contained in:
Manuel Barkhau 2020-05-25 07:45:46 +00:00
parent 02597962d0
commit 4d8395050f
9 changed files with 94 additions and 57 deletions

View file

@ -160,7 +160,7 @@ Out[4]: '/home/dev/myproject/src/myproject/__init__.py'
```
Note that the `PYTHONPATH` has been set up to import modules
of the project. You can review the definition for `make ipy`
of the project. You can review the definition for `make ipy`
to see how to set up `PYTHONPATH` correctly.
@ -215,9 +215,9 @@ projects by reducing the burdon of project setup to a minimum.
CHANGELOG.md # short documentation of release history
LICENSE # for public libraries (MIT preferred)
makefile # main project and environment management file
makefile.config.make # project configuration variables
makefile.extra.make # project specific make targets
makefile # project specific configuration
# variables and make targets
makefile.bootstrapit.make # bootstrapit make include library
docker_base.Dockerfile # base image for CI (only conda envs)
Dockerfile # image with source of the project
@ -294,7 +294,7 @@ Dependencies are installed in this order:
- `development.txt`
- `integration.txt`
Please review the documentation header at the beginning of each
Please review the documentation header at the beginning of each
`requirements/*.txt` file to determine which file is appropriate
for the dependency you want to add.
@ -355,7 +355,7 @@ The typical commands used during development are:
- `make install`: Setup virtual environment
- `source activate`: Activate virtual environment
- `make help`: Overview of tasks
- `make fmt`: Format code
- `make fmt`: Format code
- `make lint`: Linting
- `make mypy`: Typecheck
- `make devtest`: Run unittests with dev interpreter against code from `src/`.
@ -374,7 +374,7 @@ Slightly less common but good to run before doing `git push`.
The base image of the project is `docker_base.Dockerfile` which is
used to create images that have only the conda virtual environment needed
to run the project. The CI environment uses the image generated by
to run the project. The CI environment uses the image generated by
`make docker_build`. While this means that the CI setup is simpler and faster,
as you don't have to build the image for the test run in the CI environment, it does mean that you have to run `make docker_build` every time one of your dependencies is updated.
@ -394,7 +394,7 @@ Solving environment: ...working... done
conda create --name myproject_py35 python=3.5 ...
Solving environment: ...working... done
docker push
docker push
```
As is the case for your local development setup, every version of python
@ -445,11 +445,11 @@ Please read, view at your leasure:
Keep in mind, that all of this is about the form of your code, and
catching common pitfalls or gotchas. None of this releives you of the
burdon of thinking about your code. The reason to use linters and type
checking is not to have a tool to make your code correct, but to
checking is not to have a tool to make your code correct, but to
support you to make your code correct.
For now I won't go into the effort of writing yet another style guide.
Instead, if your code passes `make fmt lint`, then it's acceptable.
Instead, if your code passes `make fmt lint`, then it's acceptable.
Every time you encounter a linting error, consider it as an opportinity
to learn a best practice and look up the error code.