diff options
| -rw-r--r-- | README.md | 22 |
1 files changed, 1 insertions, 21 deletions
@@ -1,24 +1,4 @@ -# Python template - -[](https://github.com/owl-corp/python-template) - -## Summary -A template Python repo with docker, linting & CI. - -To copy this simply press the "Use this template" green button near the top of the repo. - -## Changes required copying -- Pin the dependencies in [`pyproject.toml`](pyproject.toml) to a specific version -- Update the `tool.poetry` section of in [`pyproject.toml`](pyproject.toml) to be relevant to your project -- Run `make lock` to lock poetry dependencies and export to a `requirements.txt` file -- Rename [`_.github/`](_.github/) to `.github` so that CI runs - -## Changes to consider after copying -- Update the [LICENSE](LICENSE) file -- Update the schedule of the [dependabot config](.github/dependabot.yml) -- Add a static type checker, such as mypy or Pyright -- Delete [`.dockerignore](.dockerignore), [`docker-compose.yml`](docker-compose.yml) and the [build step](_.github/workflows/build.yaml) of CI if you do not plan to use docker. - +# Thallium # Contributing Run `make` from the project root to both install this project's dependencies & install the pre-commit hooks. |