8000 GitHub - joaopalmeiro/template-python-script: Opinionated Python template for new scripts.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

joaopalmeiro/template-python-script

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

template-python-script

Ruff

Opinionated Python template for new scripts.

Getting Started

  1. Go to or create the project folder.
  2. Get the template files:
npx degit github:joaopalmeiro/template-python-script

or

npx degit github:joaopalmeiro/template-python-script --force
  1. Search for template-python-script and replace it with the project name.
  2. Search for Opinionated [Python](https://www.python.org/) template for new scripts. and replace it with the (short) project description.
  3. Search for João Palmeiro and replace it with the author's name.
  4. Install pyenv (if necessary).
  5. Run the first two commands in the Development section to install Python and Pipenv (if necessary).
  6. Run the third command in the Development section to create the virtual environment.
  7. Open the NOTES.md file and install the project-specific dependencies according to the first command in the Commands section.
  8. Delete the Template References section from the NOTES.md file.
  9. Delete the Getting Started section.

Development

Install pyenv (if necessary).

pyenv install && pyenv versions
pip install pipenv==2023.11.15 && pipenv --version
pipenv install --dev --skip-lock
pipenv run codespell
pipenv run ruff check .
pipenv run ruff check --fix .
pipenv run ruff format .
pipenv run python 01.py

About

Opinionated Python template for new scripts.

Resources

License

Stars

Watchers

Forks

Languages

0