Skip to content

Commit 08d0204

Browse files
author
Wouter Vanden Hove
committed
kickoff
0 parents  commit 08d0204

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+8069
-0
lines changed

‎.cruft.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"template": "https://github.com/libranet/kickstart-python-project",
3+
"commit": "9df695cb3a4801454903f2ae047cdd50c3b8b42b",
4+
"checkout": null,
5+
"context": {
6+
"cookiecutter": {
7+
"project_name": "libranet-django",
8+
"package_name": "libranet_django",
9+
"description": "Demo django-project.",
10+
"author": "Wouter Vanden Hove",
11+
"email": "[email protected]",
12+
"git_platform": "github",
13+
"github_user": "woutervh",
14+
"version": "0.1",
15+
"copyright_year": "2023",
16+
"license": "MIT",
17+
"development_status": "Development Status :: 4 - Beta",
18+
"minimum_python": "3.10.0",
19+
"with_django": "1",
20+
"with_flask": "0",
21+
"with_fastapi": "0",
22+
"with_typer": "1",
23+
"with_postgres": "0",
24+
"support_rtd": "1",
25+
"__package_name_snake_case": "libranet_django",
26+
"_template": "https://github.com/libranet/kickstart-python-project"
27+
}
28+
},
29+
"directory": null
30+
}

‎.env.example

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Important notes regarding this .env-file:
2+
#
3+
# - For more information about .env-files, please see
4+
# https://smartmob-rfc.readthedocs.io/en/latest/2-dotenv.html
5+
#
6+
# - Use blank lines for spacing.
7+
#
8+
# - Comments start with # and always start beginning-of-line (BOL).
9+
# Inline comments are NOT supported and will break the syntax.
10+
#
11+
# - Place your secrets and passwords here, but do not commit this file back to any repository.
12+
# Also avoid transmitting these secrets to other people in plain-text.
13+
#
14+
# - Most python-interpreter related env-variables will need to be set/sourced *before* the python-interpreter starts
15+
# Reading them via sitecustomize.py comes too late, since the python-process has already started.
16+
#
17+
# - Use bash-compatible variable-assigment-syntax: FOO='BAR'
18+
# To preserve bash-compatibility, never use spaces around the equal-operator, so don't use FOO = 'BAR'.
19+
# Always single-quote the values to preserve the literal value of each character. For example if a
20+
# password contains backslashes, those should be treated as literal values, and not as escape-characters
21+
# like when double-quoting. So always use FOO='BAR', not FOO=BAR nor FOO="BAR".
22+
# TODO: docker breaks when using quotes.
23+
#
24+
# - Standard env-variables only support string-types. However in python we can easily parse strings into
25+
# other types like lists. For example FOO='BAR|BAZ', we can string-parse into FOO=["BAR", "BAZ"].
26+
#
27+
# - In bash, you can directly source this file to load all these env-var in your current bash-session:
28+
# >>> set -a && source .env && set +a
29+
# Usability-tip: Add following alias to your ~/.bashrc
30+
# >> alias source-env='set -a && source .env && set +a'
31+
32+
PROJECT_NAME='libranet_django'
33+
BASE_DIR="__CWD__"
34+
IPYTHONDIR="__CWD__/etc/ipython"
35+
PYTHONSTARTUP="__CWD__/etc/pythonstartup.py"
36+
37+
# caching
38+
CACHE_DIR="__CWD__/var/cache/"
39+
BLACK_CACHE_DIR="__CWD__/var/cache/black"
40+
IPYTHON_CACHE_DIR="__CWD__/var/cache/ipython"
41+
MYPY_CACHE_DIR="__CWD__/var/cache/mypy"
42+
PRE_COMMIT_HOME="__CWD__/var/cache/pre-commit"
43+
PYLINTHOME="__CWD__/var/cache/pylint"
44+
45+
# debugging
46+
# used by python-interpreter, cfr. https://docs.python.org/3/using/cmdline.html#environment-variables
47+
# used by ipdb / remote-pdb - cfr https://pypi.org/project/remote-pdb + cfr https://pypi.org/project/ipdb
48+
# PYTHONBREAKPOINT='pdb.set_trace'
49+
PYTHONBREAKPOINT='ipdb.set_trace'
50+
51+
# show headers in urllib3-http-connections
52+
DEBUGLEVEL_HTTPCONNECTION='1'
53+
54+
# tmp
55+
TMP="__CWD__/var/tmp"
56+
TMPDIR="__CWD__/var/tmp"
57+
TEMP="__CWD__/var/tmp"
58+
59+
# libranet-logging - etc/logging.yaml
60+
# Supported values for logging, from lowest to highest priority:
61+
# LOGLEVEL_XXX: NOTSET|TRACE|DEBUG|INFO|WARNING|ERROR
62+
LOGGING_YML_FILE="__CWD__/etc/logging.yaml"
63+
LOG_DIR="__CWD__/var/log"
64+
PYTHON_CONSOLE_FORMATTER='console_color'
65+
LOGLEVEL_ROOT='NOTSET'
66+
LOGLEVEL_ASYNCIO='NOTSET'
67+
LOGLEVEL_BLIB2TO3='INFO'
68+
69+
LOGLEVEL_DJANGO='NOTSET'
70+
LOGLEVEL_DJANGO_DB_BACKENDS='NOTSET'
71+
72+
LOGLEVEL_libranet_django='NOTSET'
73+
LOGLEVEL_HTTP_CLIENT='DEBUG'
74+
LOGLEVEL_LIBRANET_LOGGING='INFO'
75+
LOGLEVEL_MULTIPART='INFO'
76+
LOGLEVEL_PARSO='INFO'
77+
LOGLEVEL_PY_WARNINGS='NOTSET'
78+
LOGLEVEL_REQUESTS='NOTSET'
79+
LOGLEVEL_REQUESTS_PACKAGES_URLLIB3='NOTSET'
80+
LOGLEVEL_URLLIB3='NOTSET'
81+
LOGLEVEL_URLLIB3_CONNECTIONPOOL='NOTSET'
82+
LOGLEVEL_URLLIB3_UTIL_RETRY='NOTSET'
83+
PYTHONASYNCIODDEBUG='1'
84+
LOG_HANDLERS="console|debug_file|info_file|warning_file|error_file"
85+
PYTHON_ENABLE_LOGGING_TREE=0
86+
87+
88+
89+
# django
90+
DJANGO_ALLOWED_HOSTS='127.0.0.1|localhost|libranet-django'
91+
DJANGO_BASE_URL='https://example.com'
92+
DJANGO_DEBUG='1'
93+
DJANGO_SECRET_KEY='__DJANGO_SECRET_KEY__'
94+
DJANGO_SETTINGS_MODULE='libranet_django.settings'
95+
GUNICORN_CMD_ARGS='--bind=0.0.0.0:5000 --workers=2 --reload'
96+
WAGTAILADMIN_BASE_URL='https://example.com'
97+
98+
# serve app via uvicorn, see https://www.uvicorn.org/settings/
99+
UVICORN_PORT='8000'
100+
UVICORN_HOST='0.0.0.0'
101+
UVICORN_RELOAD='1'
102+
103+
104+

‎.github/CODEOWNERS

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# This is a comment.
2+
3+
# About this file:
4+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
5+
# - Inline comments are supported.
6+
# - Filelocation must be one of: /CODEOWNERS, /docs/CODEOWNERS, /.github/CODEOWNERS
7+
# - Each line is a file pattern followed by one or more owners.
8+
# - Order is important. The last matching pattern takes the most precedence.
9+
10+
# These owners will be the default owners for everything in
11+
# the repo. Unless a later match takes precedence,
12+
# These will be requested for review when someone opens a pull request.
13+
14+
# * woutervh # via github-username
15+
* [email protected] # via email assocciated with a github-username

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/_archive/constraints.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pip==23.0.1
2+
nox==2022.11.21
3+
nox-poetry==1.0.2
4+
poetry==1.3.2
5+
virtualenv==20.15.0

‎.github/_archive/labeler.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Labeler
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
9+
jobs:
10+
labeler:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out the repository
14+
uses: actions/checkout@v3
15+
16+
- name: Run Labeler
17+
uses: crazy-max/[email protected]
18+
with:
19+
skip-delete: true

‎.github/_archive/labels.yml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
# Labels names are important as they are used by Release Drafter to decide
3+
# regarding where to record them in changelog or if to skip them.
4+
#
5+
# The repository labels will be automatically configured using this file and
6+
# the GitHub Action https://github.com/marketplace/actions/github-labeler.
7+
- name: breaking
8+
description: Breaking Changes
9+
color: bfd4f2
10+
- name: bug
11+
description: Something isn't working
12+
color: d73a4a
13+
- name: build
14+
description: Build System and Dependencies
15+
color: bfdadc
16+
- name: ci
17+
description: Continuous Integration
18+
color: 4a97d6
19+
- name: dependencies
20+
description: Pull requests that update a dependency file
21+
color: 0366d6
22+
- name: documentation
23+
description: Improvements or additions to documentation
24+
color: 0075ca
25+
- name: duplicate
26+
description: This issue or pull request already exists
27+
color: cfd3d7
28+
- name: enhancement
29+
description: New feature or request
30+
color: a2eeef
31+
- name: github_actions
32+
description: Pull requests that update Github_actions code
33+
color: "000000"
34+
- name: good first issue
35+
description: Good for newcomers
36+
color: 7057ff
37+
- name: help wanted
38+
description: Extra attention is needed
39+
color: 008672
40+
- name: invalid
41+
description: This doesn't seem right
42+
color: e4e669
43+
- name: performance
44+
description: Performance
45+
color: "016175"
46+
- name: python
47+
description: Pull requests that update Python code
48+
color: 2b67c6
49+
- name: question
50+
description: Further information is requested
51+
color: d876e3
52+
- name: refactoring
53+
description: Refactoring
54+
color: ef67c4
55+
- name: removal
56+
description: Removals and Deprecations
57+
color: 9ae7ea
58+
- name: style
59+
description: Style
60+
color: c120e5
61+
- name: testing
62+
description: Testing
63+
color: b1fc6f
64+
- name: wontfix
65+
description: This will not be worked on
66+
color: ffffff

‎.github/_archive/release-drafter.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
categories:
2+
- title: ":boom: Breaking Changes"
3+
label: "breaking"
4+
- title: ":rocket: Features"
5+
label: "enhancement"
6+
- title: ":fire: Removals and Deprecations"
7+
label: "removal"
8+
- title: ":beetle: Fixes"
9+
label: "bug"
10+
- title: ":racehorse: Performance"
11+
label: "performance"
12+
- title: ":rotating_light: Testing"
13+
label: "testing"
14+
- title: ":construction_worker: Continuous Integration"
15+
label: "ci"
16+
- title: ":books: Documentation"
17+
label: "documentation"
18+
- title: ":hammer: Refactoring"
19+
label: "refactoring"
20+
- title: ":lipstick: Style"
21+
label: "style"
22+
- title: ":package: Dependencies"
23+
labels:
24+
- "dependencies"
25+
- "build"
26+
template: |
27+
## Changes
28+
29+
$CHANGES

0 commit comments

Comments
 (0)