Giter Club home page Giter Club logo

python-try's Introduction

python-try

Release Build status codecov License

This is a template repository for Python projects that use Poetry for their dependency management. It has been generated from the cookiecutter-poetry repo. Unfortunately it is not maintained anymore. Therefore, this repo.

Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin [email protected]:vkuehn/python-try.git
git push -u origin main

Finally, install the environment and the pre-commit hooks with

python3 -m venv .venv
source ./venv/bin/activate
pip install -U pip
pip install -r requierments.txt
make install

Make sure.

  • that github pages is enabled for your repo in github.com/yourname/reponame/settings/pages.
  • that you may need to give the GITHUB_TOKEN write permission. Go to your repository's Settings > Actions > General > Workflow Permissions and select Read and write permissions.
  • before actively using make sure you get your first minor release version.
  • rename everything python_try to your reponame

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

Features

  • see makefile for options during development
    • mkdocs generates source code documentation see mkdocs.yml
    • poetry builds project and dependencies
  • pre commit hook see .pre-commit-config.yaml
    • case conflict
    • merge conflicts
    • check toml
    • check yaml
    • fix end of files
    • trim trailing whitespaces
    • fix README.md
    • run ruff
    • run prettier
  • Pipelines
    • on-release-main - use mkdocs to publish documentation on GitPages more to come once I understand all of it

ToDo

these from the original repo do not yet work To finalize the set-up for publishing to PyPi or Artifactory, see here. To enable the code coverage reports, see here.

Releasing a new version


python-try's People

Contributors

vkuehn avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.