Skip to content

Commit 6e7bd87

Browse files
committed
📝 docs: update documentation with new task commands and versions
- Add code:lint, code:check, dependencies:security, dependencies:tree commands - Rename upgrade:package to dependencies:upgrade:package - Update Django 5.2.8, Wagtail 7.2, PostgreSQL 17 in DEVELOPMENT.md - Document Django 5.1+ STORAGES API for S3 configuration
1 parent f9b6297 commit 6e7bd87

File tree

3 files changed

+55
-16
lines changed

3 files changed

+55
-16
lines changed

CLAUDE.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,14 @@ task code:format
116116
# or: toast code:format
117117
# or: python -m ruff format pythonie
118118

119-
# Lint (legacy, may still be used)
120-
flake8 pythonie/
119+
# Lint code and fix issues
120+
task code:lint
121+
# or: toast code:lint
122+
# or: python -m ruff check --fix pythonie
123+
124+
# Check code formatting and linting without changes
125+
task code:check
126+
# or: toast code:check
121127
```
122128

123129
### Dependency Management
@@ -139,7 +145,13 @@ task dependencies:upgrade
139145
task dependencies:upgrade:wagtail
140146

141147
# Upgrade specific package
142-
task upgrade:package PACKAGE=django
148+
task dependencies:upgrade:package PACKAGE=django
149+
150+
# Check for security vulnerabilities
151+
task dependencies:security
152+
153+
# Show dependencies tree
154+
task dependencies:tree
143155
```
144156

145157
### Database Operations (Heroku)

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,12 @@ refactor/simplify-sponsor-model
170170
task code:format
171171
# or: python -m ruff format pythonie
172172

173-
# Check for issues without fixing
174-
python -m ruff check pythonie
173+
# Lint code and fix issues
174+
task code:lint
175+
# or: python -m ruff check --fix pythonie
176+
177+
# Check code formatting and linting without changes
178+
task code:check
175179
```
176180

177181
### Django/Wagtail Conventions

DEVELOPMENT.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
### Tech Stack
2424

25-
- **Framework**: Django 5.0.14
26-
- **CMS**: Wagtail 6.2.x
25+
- **Framework**: Django 5.2.8
26+
- **CMS**: Wagtail 7.2
2727
- **Python**: 3.12 (required)
28-
- **Database**: PostgreSQL 13 (prod), SQLite (dev)
28+
- **Database**: PostgreSQL 17 (prod), SQLite (dev)
2929
- **Cache**: Redis 6.2
3030
- **Storage**: AWS S3 (prod), Local (dev)
3131
- **Server**: Gunicorn (prod), Runserver (dev)
@@ -609,11 +609,21 @@ email = f"{speaker.id}@sessionize.com"
609609
### 3. AWS S3 (Production)
610610

611611
**Configuration** (`pythonie/pythonie/settings/production.py`):
612+
613+
Django 5.1+ uses the `STORAGES` API instead of `DEFAULT_FILE_STORAGE`:
612614
```python
613-
DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
615+
STORAGES = {
616+
"default": {
617+
"BACKEND": "storages.backends.s3boto3.S3Boto3Storage",
618+
},
619+
"staticfiles": {
620+
"BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
621+
},
622+
}
614623
AWS_STORAGE_BUCKET_NAME = os.environ.get("AWS_STORAGE_BUCKET_NAME")
615624
AWS_S3_CUSTOM_DOMAIN = "s3.python.ie"
616625
AWS_S3_OBJECT_PARAMETERS = {"CacheControl": "max-age=86400"}
626+
MEDIA_URL = f"https://{AWS_S3_CUSTOM_DOMAIN}/"
617627
```
618628

619629
**Required env variables**:
@@ -657,7 +667,13 @@ task dependencies:upgrade
657667
task dependencies:upgrade:wagtail
658668

659669
# Upgrade specific package
660-
task upgrade:package PACKAGE=django
670+
task dependencies:upgrade:package PACKAGE=django
671+
672+
# Check for security vulnerabilities
673+
task dependencies:security
674+
675+
# Show dependencies tree
676+
task dependencies:tree
661677
```
662678

663679
**Manual process**:
@@ -1238,8 +1254,11 @@ task run
12381254
### 3. Test Before Commit
12391255

12401256
```bash
1241-
task tests # Full tests
1242-
task code:format # Format code with ruff
1257+
task tests # Full tests
1258+
task code:format # Format code with ruff
1259+
task code:lint # Lint code and fix issues
1260+
task code:check # Check without changes
1261+
task dependencies:security # Check for security vulnerabilities
12431262
```
12441263

12451264
### 4. Create Atomic Migrations
@@ -1344,14 +1363,18 @@ task database:pull # Pull Heroku DB
13441363
task database:push # Push to Heroku (danger)
13451364
task database:reset # Reset local DB
13461365

1347-
# Tests
1366+
# Tests & Code Quality
13481367
task tests # Run all tests
13491368
task code:format # Format with ruff
1369+
task code:lint # Lint and fix issues
1370+
task code:check # Check without changes
13501371

13511372
# Dependencies
13521373
task dependencies:compute # Recompile requirements
13531374
task dependencies:outdated # Check outdated
13541375
task dependencies:upgrade # Upgrade all
1376+
task dependencies:security # Check for security vulnerabilities
1377+
task dependencies:tree # Show dependencies tree
13551378

13561379
# Imports
13571380
task pycon:import:sessionize # Import Sessionize Excel
@@ -1406,7 +1429,7 @@ pythonie/pythonie/wsgi.py # WSGI application
14061429

14071430
---
14081431

1409-
**Last updated**: 2024
1410-
**Django Version**: 5.0.14
1411-
**Wagtail Version**: 6.2.x
1432+
**Last updated**: 2025
1433+
**Django Version**: 5.2.8
1434+
**Wagtail Version**: 7.2
14121435
**Python Version**: 3.12

0 commit comments

Comments
 (0)