https://github.com/kilgoretrout1985/default-py-template

Default Python project template
https://github.com/kilgoretrout1985/default-py-template

autotesting github-actions project python template template-repository tox

Last synced: about 14 hours ago
JSON representation

Default Python project template

• Host: GitHub
• URL: https://github.com/kilgoretrout1985/default-py-template
• Owner: kilgoretrout1985
• License: mit
• Created: 2022-07-22T12:47:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-20T11:02:07.000Z (about 2 years ago)
• Last Synced: 2024-01-17T00:16:09.778Z (10 months ago)
• Topics: autotesting, github-actions, project, python, template, template-repository, tox
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# default-py-template

Default Python project template with linter, type checking and test environment 

setup. Also supporting github auto-running tests on push to repository.

![Tests](https://github.com/kilgoretrout1985/default-py-template/actions/workflows/tests.yaml/badge.svg)

## Use

To use this project's structure in a new project without leaving dependency 

on this stub project:

1)

```

git clone https://github.com/kilgoretrout1985/default-py-template.git yourrealprojectname

cd yourrealprojectname

rm -drf .git

git init .

```

2) Search all occurences of `projectname` in project files (and in dir- and file-names!) 

and replace them with `yourrealprojectname`.

3) Browse `setup.cfg` and `README.md` to change author name, email and github 

links to the actual ones.

4)

```

python3 -m venv .env && \

source .env/bin/activate && \

pip install -U pip && \

pip install -e .[dev]

```

More on `pip install -e .` [here](https://stackoverflow.com/a/68885989/17368036).

5) Run `tox` command to check your project setup. Everything should be green at this 

point.

Happy commits!

## (c)

This repo is mainly based on [this video](https://www.youtube.com/watch?v=DhUpxWjOhME).