js-python-starter 2.5.0__tar.gz → 2.5.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,53 @@
1
+ Metadata-Version: 2.4
2
+ Name: js-python-starter
3
+ Version: 2.5.2
4
+ Summary: A starter project for quickly setting up new Python apps
5
+ Author-email: jnstockley <jnstockley@users.noreply.github.com>
6
+ Project-URL: Homepage, https://github.com/jnstockley/python-starter
7
+ Project-URL: Repository, https://github.com/jnstockley/python-starter.git
8
+ Project-URL: Issues, https://github.com/jnstockley/python-starter/issues
9
+ Keywords: starter,template,python
10
+ Classifier: Programming Language :: Python :: 3
11
+ Requires-Python: <4.0,>=3.13
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: python-dotenv==1.2.1
15
+ Dynamic: license-file
16
+
17
+ # Python Starter
18
+
19
+ ## Steps to set up
20
+ 1. Create a new repository in GitHub using this repository as a template
21
+ 2. Generate Docker Hub PAT (Personal Access Token)
22
+ 3. Create an [Environment in GitHub](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#creating-an-environment) with the following secrets
23
+ - DOCKER_USERNAME (Docker Hub username)
24
+ - DOCKER_PASSWORD (Docker Hub PAT)
25
+ 4. Create a Docker Hub repository with the same name as the GitHub repository
26
+ 5. Update `assignees` in `renovate.json` with your GitHub username
27
+ 6. Set up code-cove and make sure it has access to this repository
28
+ - https://docs.codecov.com/docs/quick-start
29
+ 7. Setup branch protection rules
30
+ - Set `Enrforcment Status` to `Enabled`
31
+ - Make sure `Target branches` set to `main` or default branch
32
+ - Ensure these `Branch rules` are selected
33
+ - `Restrict deletions`
34
+ - `Require status checks to pass` with these checks
35
+ - `Lint`
36
+ - `Test`
37
+ - `Block force pushes`
38
+ 8. Create a PyPi `Trusted Publisher`
39
+ - https://pypi.org/manage/account/publishing/
40
+ 9. Ensure the name in `pyproject.toml` matches the name of the package on PyPi
41
+ 10. Make sure the following linters are installed externally of the project
42
+ - yamllint
43
+ - shellcheck
44
+ - shfmt
45
+ - node (npx/dclint)
46
+
47
+ ## TODO
48
+ - [X] Handle GitHub pre-release
49
+ - [X] Update PYTHONPATH with src folder
50
+ - [X] Add custom user to Dockerfile
51
+ - [ ] Fix Dockerfile
52
+ - [ ] Fix health check
53
+ - [ ] Fix version number
@@ -1,17 +1,16 @@
1
1
  [project]
2
2
  name = "js-python-starter"
3
- version = "2.5.0"
3
+ version = "2.5.2"
4
4
  description = "A starter project for quickly setting up new Python apps"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.13, <4.0"
7
- license = { file = "LICENSE" }
7
+ license-files = ["LICENSE"]
8
8
  authors = [
9
- { name = "Jack Stockley", email = "jack@jstockley.com"}
9
+ { name = "jnstockley", email = "jnstockley@users.noreply.github.com"}
10
10
  ]
11
11
  keywords = ["starter", "template", "python"]
12
12
  classifiers = [
13
13
  "Programming Language :: Python :: 3",
14
- "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
15
14
  ]
16
15
  dependencies = [
17
16
  "python-dotenv==1.2.1",
@@ -0,0 +1,53 @@
1
+ Metadata-Version: 2.4
2
+ Name: js-python-starter
3
+ Version: 2.5.2
4
+ Summary: A starter project for quickly setting up new Python apps
5
+ Author-email: jnstockley <jnstockley@users.noreply.github.com>
6
+ Project-URL: Homepage, https://github.com/jnstockley/python-starter
7
+ Project-URL: Repository, https://github.com/jnstockley/python-starter.git
8
+ Project-URL: Issues, https://github.com/jnstockley/python-starter/issues
9
+ Keywords: starter,template,python
10
+ Classifier: Programming Language :: Python :: 3
11
+ Requires-Python: <4.0,>=3.13
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: python-dotenv==1.2.1
15
+ Dynamic: license-file
16
+
17
+ # Python Starter
18
+
19
+ ## Steps to set up
20
+ 1. Create a new repository in GitHub using this repository as a template
21
+ 2. Generate Docker Hub PAT (Personal Access Token)
22
+ 3. Create an [Environment in GitHub](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#creating-an-environment) with the following secrets
23
+ - DOCKER_USERNAME (Docker Hub username)
24
+ - DOCKER_PASSWORD (Docker Hub PAT)
25
+ 4. Create a Docker Hub repository with the same name as the GitHub repository
26
+ 5. Update `assignees` in `renovate.json` with your GitHub username
27
+ 6. Set up code-cove and make sure it has access to this repository
28
+ - https://docs.codecov.com/docs/quick-start
29
+ 7. Setup branch protection rules
30
+ - Set `Enrforcment Status` to `Enabled`
31
+ - Make sure `Target branches` set to `main` or default branch
32
+ - Ensure these `Branch rules` are selected
33
+ - `Restrict deletions`
34
+ - `Require status checks to pass` with these checks
35
+ - `Lint`
36
+ - `Test`
37
+ - `Block force pushes`
38
+ 8. Create a PyPi `Trusted Publisher`
39
+ - https://pypi.org/manage/account/publishing/
40
+ 9. Ensure the name in `pyproject.toml` matches the name of the package on PyPi
41
+ 10. Make sure the following linters are installed externally of the project
42
+ - yamllint
43
+ - shellcheck
44
+ - shfmt
45
+ - node (npx/dclint)
46
+
47
+ ## TODO
48
+ - [X] Handle GitHub pre-release
49
+ - [X] Update PYTHONPATH with src folder
50
+ - [X] Add custom user to Dockerfile
51
+ - [ ] Fix Dockerfile
52
+ - [ ] Fix health check
53
+ - [ ] Fix version number
@@ -3,7 +3,7 @@ import os
3
3
 
4
4
  log_level = os.getenv("LOG_LEVEL", "INFO").upper()
5
5
 
6
- log_dir = os.path.join(os.path.dirname(__file__), "..", "..", "logs")
6
+ log_dir = os.path.join(os.getenv("LOG_DIR", "../logs"))
7
7
  os.makedirs(log_dir, exist_ok=True)
8
8
 
9
9