Skip to content

Commit 4de8a72

Browse files
do some cleanup before initial release (#100)
* do some cleanup before initial release * remove `psycopg2` optional dep
1 parent 79a7caa commit 4de8a72

File tree

3 files changed

+8
-53
lines changed

3 files changed

+8
-53
lines changed

Justfile

Lines changed: 2 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,15 @@ set dotenv-load := true
77
# DEPENDENCIES #
88
##################
99

10-
@bootstrap:
10+
bootstrap:
1111
python -m pip install --editable '.[dev,hc,relay]'
1212

13-
install:
14-
python -m pip install --editable '.[dev]'
15-
1613
pup:
1714
python -m pip install --upgrade pip
1815

1916
update:
2017
@just pup
21-
@just install
18+
@just bootstrap
2219

2320
venv PY_VERSION="3.11.5":
2421
#!/usr/bin/env python
@@ -95,27 +92,6 @@ createsuperuser USERNAME="admin" EMAIL="" PASSWORD="admin":
9592
# DOCKER #
9693
##################
9794

98-
enter CONTAINER="relay[-_]devcontainer[-_]app" SHELL="zsh" WORKDIR="/workspace" USER="vscode":
99-
#!/usr/bin/env sh
100-
if [ -f "/.dockerenv" ]; then
101-
echo "command cannot be run from within a Docker container"
102-
else
103-
case {{ SHELL }} in
104-
"zsh" )
105-
shell_path="/usr/bin/zsh" ;;
106-
"bash" )
107-
shell_path="/bin/bash" ;;
108-
"sh" )
109-
shell_path="/bin/sh" ;;
110-
* )
111-
shell_path="/usr/bin/zsh" ;;
112-
esac
113-
114-
container=$(docker ps --filter "name={{ CONTAINER }}" --format "{{{{.Names}}")
115-
116-
docker exec -it -u {{ USER }} -w {{ WORKDIR }} $container $shell_path
117-
fi
118-
11995
testbuild:
12096
docker build -t relay:latest -f .dockerfiles/Dockerfile .
12197

@@ -242,27 +218,6 @@ createdb CONTAINER_NAME="relay_postgres" VERSION="15.3":
242218
@docs-build LOCATION="docs/_build/html":
243219
sphinx-build docs {{ LOCATION }}
244220

245-
##################
246-
# ENV SYNC #
247-
##################
248-
249-
envsync:
250-
#!/usr/bin/env python
251-
from pathlib import Path
252-
253-
envfile = Path('.env')
254-
envfile_example = Path('.env.example')
255-
256-
if not envfile.exists():
257-
envfile.write_text(envfile_example.read_text())
258-
259-
with envfile.open() as f:
260-
lines = [line for line in f.readlines() if not line.endswith('# envsync: ignore\n')]
261-
lines = [line.split('=')[0] + '=\n' if line.endswith('# envsync: no-value\n') else line for line in lines]
262-
263-
lines.sort()
264-
envfile_example.write_text(''.join(lines))
265-
266221
##################
267222
# UTILS #
268223
##################

RELEASING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ When it comes time to cut a new release, follow these steps:
1616

1717
The `pyproject.toml` in the base of the repository contains a `[tool.bumpver]` section that configures the `bumpver` tool to update the version number wherever it needs to be updated and to create a commit with the appropriate commit message.
1818

19-
If you have not already installed `bumpver`, you can install it with:
19+
`bumpver` is included as a development dependency, so you should already have it installed if you have installed the development dependencies for this project. If you do not have the development dependencies installed, you can install them with either of the following commands:
2020

2121
```shell
22-
python -m pip install bumpver
22+
python -m pip install --editable '.[dev]'
23+
# or using the included `Justfile`
24+
just bootstrap
2325
```
2426

2527
Then, run `bumpver` to update the version number, with the appropriate command line arguments. See the [`bumpver` documentation](https://github.com/mbarkhau/bumpver) for more details.

pyproject.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ classifiers = [
1212
"Framework :: Django :: 3",
1313
"Framework :: Django :: 3.2",
1414
"Framework :: Django :: 4",
15-
"Framework :: Django :: 4.0",
1615
"Framework :: Django :: 4.1",
1716
"Framework :: Django :: 4.2",
1817
"License :: OSI Approved :: MIT License",
@@ -38,8 +37,8 @@ requires-python = ">=3.8"
3837

3938
[project.optional-dependencies]
4039
dev = [
40+
"bumpver",
4141
"coverage[toml]",
42-
"django-email-relay[hc,relay]",
4342
"django-stubs",
4443
"django-stubs-ext",
4544
"faker",
@@ -68,11 +67,10 @@ docs = [
6867
hc = ["requests"]
6968
lint = ["pre-commit"]
7069
psycopg = ["psycopg[binary]"]
71-
psycopg2 = ["psycopg2-binary"]
7270
relay = ["environs[django]"]
7371

7472
[project.urls]
75-
Documentation = "https://github.com/westerveltco/django-email-relay#readme"
73+
Documentation = "https://django-email-relay.westervelt.dev"
7674
Issues = "https://github.com/westerveltco/django-email-relay/issues"
7775
Source = "https://github.com/westerveltco/django-email-relay"
7876

0 commit comments

Comments
 (0)