Skip to content

Commit ec921ef

Browse files
Merge branch 'main' into dependabot/pip/jupyter-core-4.11.2
2 parents c93b826 + 4e0e8fa commit ec921ef

Some content is hidden

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

74 files changed

+4204
-1044
lines changed

.cruft.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"template": "https://github.com/pythoninthegrass/python_template",
3+
"commit": "e38acd06e49e1acf755cf4d84c607344c7d31c0d",
4+
"context": {
5+
"cookiecutter": {
6+
"full_name": "Lance Stephens",
7+
"email": "4097471+pythoninthegrass@users.noreply.github.com",
8+
"github_username": "pythoninthegrass",
9+
"project_name": "python_template",
10+
"project_slug": "python_template",
11+
"project_short_description": "python_template contains all the boilerplate you need to create a Python project.",
12+
"pypi_username": "pythoninthegrass",
13+
"version": "0.1.0",
14+
"use_pytest": "n",
15+
"use_black": "n",
16+
"use_pypi_deployment_with_travis": "n",
17+
"add_pyup_badge": "n",
18+
"command_line_interface": "No command-line interface",
19+
"create_author_file": "n",
20+
"open_source_license": "Unlicense",
21+
"_template": "https://github.com/pythoninthegrass/python_template"
22+
}
23+
},
24+
"directory": null
25+
}

.env.example

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
REGISTRY_URL=1234.dkr.ecr.us-east-1.amazonaws.com
1+
#REGISTRY_URL=1234.dkr.ecr.us-east-1.amazonaws.com
2+
REGISTRY_URL=https://index.docker.io/v1/
23
APP_NAME=appname
3-
TAG=latest
4-
EMAIL=thisismysingingvoice@acme.co
5-
URL=https://acme.co
4+
IMAGE=centos
5+
TAG=7.8.2003
66
USER=apiuser
77
PASSWORD=apiuserpassword
8-
VERBOSE=false
8+
EMAIL=thisismysingingvoice@acme.co
9+
HOST=localhost
910
OVERWRITE=true
11+
PORT=1812
1012
PORT=80
13+
PORT2=18120
14+
URL=https://acme.co
15+
VERBOSE=false

.github/ISSUE_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
* Python version:
2+
* asdf version:
3+
* Poetry version:
4+
* Operating System:
5+
6+
## Description
7+
Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.
8+
9+
## What I Did
10+
```bash
11+
Paste the command(s) you ran and the output.
12+
```
13+
14+
## Anything relevant that isn't listed

.github/workflows/codeql_analysis.yml

Lines changed: 0 additions & 72 deletions
This file was deleted.

.github/workflows/push.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
python 3.10.8
1+
python 3.11.0
22
poetry 1.2.2

.vscode/launch.json

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,62 @@
77

88
"version": "0.2.0",
99
"configurations": [
10+
{
11+
"name": "Python: Current File",
12+
"type": "python",
13+
"request": "launch",
14+
"program": "${file}",
15+
"console": "integratedTerminal",
16+
"cwd": "${fileDirname}",
17+
// "args": ["-i", "response.xml", "-o", "response.csv"],
18+
// "args": ["-d", "/Volumes/Data"],
19+
// "args": ["-f", "menubar.dmg"],
20+
// "args": ["-h"],
21+
// "env": {
22+
// "CREDS": "",
23+
// }
24+
},
25+
{
26+
"name": "Python: Django",
27+
"type": "python",
28+
"request": "launch",
29+
"program": "${workspaceFolder}/manage.py",
30+
"console": "integratedTerminal",
31+
"args": ["runserver"],
32+
"django": true,
33+
"justMyCode": true
34+
},
35+
{
36+
"name": "Python: Flask",
37+
"type": "python",
38+
"request": "launch",
39+
"program": "${workspaceFolder}/.venv/bin/flask",
40+
"console": "integratedTerminal",
41+
"args": [
42+
"run",
43+
"--host",
44+
"0.0.0.0",
45+
"--port",
46+
"8000"
47+
],
48+
"justMyCode": true
49+
},
50+
{
51+
"name": "Python: Flet",
52+
"type": "python",
53+
"request": "launch",
54+
"program": "${workspaceFolder}/.venv/bin/flet",
55+
"console": "integratedTerminal",
56+
"args": [
57+
"run",
58+
"main.py",
59+
"-d"
60+
],
61+
"env": {
62+
"PYDEVD_DISABLE_FILE_VALIDATION": "1",
63+
},
64+
"justMyCode": true
65+
},
1066
{
1167
"name": "Python: Debug Tests",
1268
"type": "python",

.vscode/settings.json

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Very little of this gets tested on Windows hosts. Windows Subsystem for Linux (W
1414
Be the change et al if Windows is your main and you wanna [raise a PR](CONTRIBUTING.md) with broad instructions on getting tooling working under Windows (e.g., docker, poetry, playwright.)
1515

1616
**Table of Contents**
17-
* [python_template](#python_template)
17+
* [python\_template](#python_template)
1818
* [Summary](#summary)
1919
* [Caveat Emptor](#caveat-emptor)
2020
* [Setup](#setup)
@@ -40,17 +40,20 @@ Be the change et al if Windows is your main and you wanna [raise a PR](CONTRIBUT
4040
Development environments and tooling are first-class citizens on macOS and *nix. For Windows faithfuls, please setup [WSL](markdown/wsl.md).
4141

4242
## Pushing to Docker Hub with CI
43-
Docker Hub is a cloud-based repository in which Docker users and partners create, test, store and distribute container images. Docker images are pushed to Docker Hub through the docker push command. A single Docker Hub repository can hold many Docker images (stored as tags).
43+
Docker Hub is a cloud-based repository in which Docker users and partners create, test, store and distribute container images. Docker images are pushed to Docker Hub through the `docker push` command. A single Docker Hub repository can hold many Docker images (stored as tags).
4444

45-
Automated CI is implemented via GitHub Actions to build and push this repository's image to Docker Hub in `/.github/workflows/push.yml`.
45+
Automated CI is implemented via GitHub Actions to build and push this repository's image to Docker Hub in `.github/workflows/ci.yml`.
4646

4747
### What you need to modify in this file
48+
* Add repository secrets (Docker Hub)
49+
* `DOCKERHUB_TOKEN`
50+
* `DOCKERHUB_USER`
51+
* Add environment variable (image name)
52+
* `APP_NAME`
4853

49-
* Look for `images: your-username/your-image-name` and change to your respective Docker Hub username and image name.
50-
* Add repository secrets for `DOCKERHUB_TOKEN` and `DOCKERHUB_USERNAME` on this repository on GitHub.
51-
* Here are the [instructions to create a token](https://docs.docker.com/docker-hub/access-tokens/#create-an-access-token).
54+
[Instructions to create a token](https://docs.docker.com/docker-hub/access-tokens/#create-an-access-token).
5255

53-
Here are the [instructions to disable this action](https://docs.github.com/en/actions/managing-workflow-runs/disabling-and-enabling-a-workflow) if you don't want this feature.
56+
[Instructions to disable this action](https://docs.github.com/en/actions/managing-workflow-runs/disabling-and-enabling-a-workflow) if you don't want this feature.
5457

5558
## TODO
5659
* [Open Issues](https://github.com/pythoninthegrass/python_template/issues)

cookiecutter.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"full_name": "Lance Stephens",
3+
"email": "4097471+pythoninthegrass@users.noreply.github.com",
4+
"github_username": "pythoninthegrass",
5+
"project_name": "python_template",
6+
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
7+
"project_short_description": "python_template contains all the boilerplate you need to create a Python project.",
8+
"pypi_username": "{{ cookiecutter.github_username }}",
9+
"version": "0.1.0",
10+
"use_pytest": "n",
11+
"use_black": "n",
12+
"use_pypi_deployment_with_travis": "n",
13+
"add_pyup_badge": "n",
14+
"command_line_interface": [
15+
"Click",
16+
"Argparse",
17+
"No command-line interface"
18+
],
19+
"create_author_file": "y",
20+
"open_source_license": [
21+
"Unlicense",
22+
"MIT license",
23+
"BSD license",
24+
"ISC license",
25+
"Apache Software License 2.0",
26+
"GNU General Public License v3",
27+
"Not open source"
28+
]
29+
}

0 commit comments

Comments
 (0)