You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--- Please write your PR name in the present imperative tense. Examples of that tense are: "Fix issue in the dispatcher where…", "Improve our handling of…", etc." -->
2
-
<!-- For more information on Pull Requests, you can reference here: https://success.vanillaforums.com/kb/articles/228-using-pull-requests-to-contribute -->
1
+
<!---
2
+
Please write your PR name in the present imperative tense. Examples of that tense are:
3
+
"Fix issue in the dispatcher where…", "Improve our handling of…", etc."
4
+
5
+
For more information on Pull Requests, you can reference here:
This repository is a template for a python 🐍 project using the poetry container. The intent is to do all the basic lifting for a python project so that people can hit the ground running with their ideas.
2
+
This repository is a template for a python 🐍 project using the poetry container. The intent is to do all the basic
3
+
lifting for a python project so that people can hit the ground running with their ideas.
3
4
4
5
### To make this project your own
5
6
1. Create a new repository, [using this one as a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
6
7
2. Change the `project` folder name to the kebab-case name of your project.
7
-
3. Update the `BASE_DIR` variable value in the `Makefile` with the kebab-case name of your project.
8
-
4. Update the information in the `pyproject.toml` file with your project's and your personal information.
9
-
5. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.
8
+
3. Update the information in the `pyproject.toml` file with your project's and your personal information.
9
+
4. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.
10
10
11
11
### 🐍 by Default (Feel free to delete this after creating your project)
12
-
-[pre-commit]([https://github.com/psf/black](https://pre-commit.com/)): This serves as the codebase formatter and linter.
13
-
-[Requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
14
-
-[Responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.
12
+
-[pre-commit](https://pre-commit.com/): This serves as the codebase formatter and linter.
13
+
-[requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
14
+
-[responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.
15
15
16
16
### Project Requirements
17
17
- Python version: `^3.11`
@@ -26,6 +26,6 @@ This repository is a template for a python 🐍 project using the poetry contain
26
26
- Example: `poetry add black`
27
27
28
28
## Standard Commands
29
-
-`make lint`: Runs `pre-commit`
30
-
-`make test`: Runs test cases in the `test` directory
31
-
-`make run`: Runs the `main` function in the `project` folder
29
+
-`make lint`: Runs `pre-commit`.
30
+
-`make test`: Runs test cases in the `test` directory.
31
+
-`make run`: Runs the `main` function in the `project` folder.
0 commit comments