https://github.com/libcommon/template-repo-py
Template repository for Python projects.
https://github.com/libcommon/template-repo-py
docker python python-poetry python3 shell-script
Last synced: 10 months ago
JSON representation
Template repository for Python projects.
- Host: GitHub
- URL: https://github.com/libcommon/template-repo-py
- Owner: libcommon
- Created: 2019-11-25T03:40:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T04:23:41.000Z (over 1 year ago)
- Last Synced: 2025-01-17T08:12:09.824Z (11 months ago)
- Topics: docker, python, python-poetry, python3, shell-script
- Language: Shell
- Homepage:
- Size: 384 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# template-repo-py: Template Repo for Python projects
## Overview
## Installation
### Install from Pypi (preferred method)
```bash
pip install template_repo_py
```
### Install Directly with Pip and Git
```bash
pip install git+ssh://git@github.com/libcommon/template-repo-py.git#egg=template-repo-py&subdirectory=src
```
### Install from Cloned Repo
```bash
git clone ssh://git@github.com/libcommon/template-repo-py.git && \
cd template-repo-py && \
pip install .
```
## Dependencies
The `tool.poetry.*dependencies` sections in [pyproject.toml](pyproject.toml) contain the app and dev dependencies.
See [DEVELOPMENT.md](DEVELOPMENT.md) for local development and build dependencies.
## Getting Started
TODO
## Development
See [DEVELOPMENT.md](DEVELOPMENT.md) for development instructions.
## Contributing/Suggestions
Contributions and suggestions are welcome! To make a feature request, report a bug, or otherwise comment on existing
functionality, please file an issue. For contributions please submit a PR, but make sure to lint, type-check, and test
your code before doing so. Thanks in advance!