Skip to content

Commit

Permalink
chore: update template
Browse files Browse the repository at this point in the history
  • Loading branch information
lyz-code committed Feb 13, 2023
1 parent 34febf5 commit 979329e
Show file tree
Hide file tree
Showing 22 changed files with 1,019 additions and 725 deletions.
2 changes: 1 addition & 1 deletion .cruft.json
@@ -1,6 +1,6 @@
{
"template": "git@github.com:lyz-code/cookiecutter-python-project.git",
"commit": "85e6779b497a75fd7bd25690a2e00763e3b1152f",
"commit": "e2247dc1d557217a1c6f8b89f9355cb9be1c8238",
"context": {
"cookiecutter": {
"project_name": "Drode",
Expand Down
12 changes: 10 additions & 2 deletions .github/workflows/tests.yml
Expand Up @@ -32,12 +32,20 @@ jobs:
source .venv/bin/activate
pdm config python.use_venv True
make install
# 3.7 is giving me some issues with flake8 and importlib-metadata, until
# https://github.com/flakeheaven/flakeheaven/issues/132 is done, I won't spend
# time testing in this environment.
# https://github.com/lyz-code/mkdocs-newsletter/actions/runs/3548202587/jobs/5959150030
- name: Test linters
run: make lint
run: if [[ ${{ matrix.python-version }} != '3.7' ]];then make lint; fi
- name: Test type checkers
run: make mypy
# 3.7 is giving me some issues with flake8 and importlib-metadata, until
# https://github.com/flakeheaven/flakeheaven/issues/132 is done, I won't spend
# time testing in this environment.
# https://github.com/lyz-code/mkdocs-newsletter/actions/runs/3548202587/jobs/5959150030
- name: Test security
run: make security
run: if [[ ${{ matrix.python-version }} != '3.7' ]];then make security; fi
- name: Test with pytest
run: make test
- name: Upload Coverage
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Expand Up @@ -5,15 +5,14 @@ black = pdm run black --target-version py39 src tests
.PHONY: install
install:
pdm install --dev
pdm run pre-commit install

.PHONY: update
update:
@echo "-------------------------"
@echo "- Updating dependencies -"
@echo "-------------------------"

pdm update --no-sync
pdm update --no-sync --update-eager
pdm sync --clean

@echo "\a"
Expand All @@ -24,7 +23,7 @@ update-production:
@echo "- Updating production dependencies -"
@echo "------------------------------------"

pdm update --production --no-sync
pdm update --production --no-sync --update-eager
pdm sync --clean

@echo "\a"
Expand All @@ -47,6 +46,7 @@ format:

$(isort)
$(black)
autoimport .

@echo ""

Expand Down
21 changes: 21 additions & 0 deletions README.md
Expand Up @@ -33,6 +33,27 @@ For guidance on setting up a development environment, and how to make
a contribution to *drode*, see [Contributing to
drode](https://lyz-code.github.io/drode/contributing).

## Donations

<noscript><a href="https://liberapay.com/Lyz/donate"><img alt="Donate using
Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
or
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T3GP0V8)

If you are using some of my open-source tools, have enjoyed them, and want to
say "thanks", this is a very strong way to do it.

If your product/company depends on these tools, you can sponsor me to ensure I
keep happily maintaining them.

If these tools are helping you save money, time, effort, or frustrations; or
they are helping you make money, be more productive, efficient, secure, enjoy a
bit more your work, or get your product ready faster, this is a great way to
show your appreciation. Thanks for that!

And by sponsoring me, you are helping make these tools, that already help you,
sustainable and healthy.

## License

GPLv3
8 changes: 8 additions & 0 deletions docs/contributing.md
Expand Up @@ -92,6 +92,14 @@ You'll need to have python 3.6, 3.7, or 3.8, virtualenv, git, and make installed
source env/bin/activate
```

* Install `pdm` our package manager with the next command or using any of the
other [recommended
methods](https://pdm.fming.dev/latest/#recommended-installation-method).

```bash
curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
```

* Install drode, dependencies and configure the
pre-commits:

Expand Down
22 changes: 22 additions & 0 deletions docs/index.md
Expand Up @@ -168,3 +168,25 @@ giants, namely:
For guidance on setting up a development environment, and how to make
a contribution to *drode*, see [Contributing to
drode](https://lyz-code.github.io/drode/contributing).
## Donations
<a href="https://liberapay.com/Lyz/donate"><img alt="Donate using
Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>
or
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T3GP0V8)
If you are using some of my open-source tools, have enjoyed them, and want to
say "thanks", this is a very strong way to do it.
If your product/company depends on these tools, you can sponsor me to ensure I
keep happily maintaining them.
If these tools are helping you save money, time, effort, or frustrations; or
they are helping you make money, be more productive, efficient, secure, enjoy a
bit more your work, or get your product ready faster, this is a great way to
show your appreciation. Thanks for that!
And by sponsoring me, you are helping make these tools, that already help you,
sustainable and healthy.
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -65,6 +65,7 @@ theme:
# logo: 'images/logo.bmp'
features:
- navigation.instant
- navigation.footer
- navigation.top
- content.code.annotate

Expand Down

0 comments on commit 979329e

Please sign in to comment.