https://github.com/gvatsal60/pythontemplate
Quickly starting Python applications with a structured, reusable setup
https://github.com/gvatsal60/pythontemplate
pip pip3 project-template python python-3 python-script python-template python3 template
Last synced: 3 months ago
JSON representation
Quickly starting Python applications with a structured, reusable setup
- Host: GitHub
- URL: https://github.com/gvatsal60/pythontemplate
- Owner: gvatsal60
- License: apache-2.0
- Created: 2024-12-20T11:10:09.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-02-03T23:55:09.000Z (3 months ago)
- Last Synced: 2025-02-04T00:33:19.480Z (3 months ago)
- Topics: pip, pip3, project-template, python, python-3, python-script, python-template, python3, template
- Language: Makefile
- Homepage:
- Size: 76.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yaml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# PythonTemplate
[](https://img.shields.io/github/license/gvatsal60/PythonTemplate)
[](https://results.pre-commit.ci/latest/github/gvatsal60/PythonTemplate/HEAD)
[](https://www.codefactor.io/repository/github/gvatsal60/PythonTemplate)
This repository serves as a foundational template for new python projects,
equipped with essential tools for maintaining code quality and documentation consistency.
It includes:
1. README.md
2. LICENSE
3. .gitignore
4. CODE_OF_CONDUCT.md
5. CONTRIBUTING.md
6. FUNDING.yml
7. CHANGELOG.md
## Table of Contents
1. [Getting Started](#getting-started)
2. [Build](#build)
3. [Run](#run)
4. [Testing](#testing)
5. [Cleaning](#cleaning)
## Getting Started
To get started with the project, ensure you have `Python 3` installed on your system.
## Build
To create virtualenv and install requirements for the project, run the following command:
```sh
make build
```
## Run
To run the main file, use the following command:
```sh
make run
```
You can also specify a particular file to run by adding the FILE variable:
Note: Path need to be mentioned if it's in a directory
```sh
make run FILE=file_name.py
or
make run FILE=app/app.py
```
## Testing
To run the tests, use the following command:
```sh
make test
```
You can also specify a particular file to test by adding the FILE variable:
Note: Path need to be mentioned if it's in a directory
```sh
make test FILE=file_name.py
```
## Cleaning
To clean the project directory, removing all compiled Python files, use the following command:
```sh
make clean
```
## Contributing
Contributions are welcome! Please read our
[Contribution Guidelines](https://github.com/gvatsal60/PythonTemplate/blob/HEAD/CONTRIBUTING.md)
before submitting pull requests.
## License
This project is licensed under the Apache License 2.0 License -
see the [LICENSE](https://github.com/gvatsal60/PythonTemplate/blob/HEAD/LICENSE)
file for details.