Compare commits
2 Commits
f602579357
...
d7ebe08091
| Author | SHA1 | Date |
|---|---|---|
|
|
d7ebe08091 | |
|
|
a4dfffb40d |
2
TODO.md
2
TODO.md
|
|
@ -1,7 +1,5 @@
|
|||
# TODO:
|
||||
|
||||
- edit readme to use poetry
|
||||
- tests
|
||||
- add AGPL
|
||||
- add CI
|
||||
- add flake
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ wheels/
|
|||
*.egg
|
||||
|
||||
# virtualenv
|
||||
.venv/
|
||||
venv/
|
||||
|
||||
# mypy
|
||||
|
|
|
|||
|
|
@ -18,13 +18,14 @@ This project if a free software released under the {{ cookiecutter.open_source_l
|
|||
|
||||
## Dev
|
||||
|
||||
If you want to tinker with this project, you can clone it and install it in editable mode:
|
||||
This project is managed by [poetry](https://python-poetry.org/).
|
||||
|
||||
To open a shell in a venv of the project:
|
||||
```
|
||||
git clone {{ cookiecutter.project_url }}.git
|
||||
cd {{ cookiecutter.project_slug }}
|
||||
python -m venv venv && source venv/bin/activate
|
||||
pip install -e .[dev]
|
||||
poetry shell
|
||||
poetry install
|
||||
```
|
||||
|
||||
### Test
|
||||
|
|
@ -32,8 +33,9 @@ pip install -e .[dev]
|
|||
Tests are run using `pytest`:
|
||||
|
||||
```
|
||||
pytest
|
||||
poetry run pytest
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Author
|
||||
|
|
|
|||
|
|
@ -17,6 +17,13 @@ python = "^3.10"
|
|||
[tool.poetry.scripts]
|
||||
{{ cookiecutter.project_slug }} = "{{ cookiecutter.project_slug }}.cli:main"
|
||||
|
||||
[tool.poetry.group.dev.dependencies]
|
||||
pytest = "*"
|
||||
pytest-cov = "*"
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
addopts = "--cov"
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core"]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
import {{ cookiecutter.project_slug }}
|
||||
|
||||
def test_dummy():
|
||||
assert True
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
import argparse
|
||||
|
||||
|
||||
def main():
|
||||
""" Console entrypoint for {{cookiecutter.project_slug}}."""
|
||||
parser = argparse.ArgumentParser()
|
||||
|
|
|
|||
Loading…
Reference in New Issue