Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
<!--- 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." -->
<!-- For more information on Pull Requests, you can reference here: https://success.vanillaforums.com/kb/articles/228-using-pull-requests-to-contribute -->
<!---
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."

For more information on Pull Requests, you can reference here:
https://success.vanillaforums.com/kb/articles/228-using-pull-requests-to-contribute
-->
## Describe your changes


Expand All @@ -10,6 +15,6 @@
<!--- These are suggested things you could add, but what you add will be dependent on your repository's standards. --->
- [ ] The code runs successfully.

```console
```commandline
HERE IS SOME COMMAND LINE OUTPUT
```
2 changes: 0 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
# https://www.gnu.org/software/make/manual/html_node/Introduction.html
default: create-requirements lint

BASEDIR=project

.PHONY: lint
lint:
pre-commit run --all-files
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Poetry Python 🐍 Project Template
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.
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.

### To make this project your own
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).
2. Change the `project` folder name to the kebab-case name of your project.
3. Update the `BASE_DIR` variable value in the `Makefile` with the kebab-case name of your project.
4. Update the information in the `pyproject.toml` file with your project's and your personal information.
5. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.
3. Update the information in the `pyproject.toml` file with your project's and your personal information.
4. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.

### 🐍 by Default (Feel free to delete this after creating your project)
- [pre-commit]([https://github.com/psf/black](https://pre-commit.com/)): This serves as the codebase formatter and linter.
- [Requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
- [Responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.
- [pre-commit](https://pre-commit.com/): This serves as the codebase formatter and linter.
- [requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
- [responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.

### Project Requirements
- Python version: `^3.11`
Expand All @@ -26,6 +26,6 @@ This repository is a template for a python 🐍 project using the poetry contain
- Example: `poetry add black`

## Standard Commands
- `make lint`: Runs `pre-commit`
- `make test`: Runs test cases in the `test` directory
- `make run`: Runs the `main` function in the `project` folder
- `make lint`: Runs `pre-commit`.
- `make test`: Runs test cases in the `test` directory.
- `make run`: Runs the `main` function in the `project` folder.