Giter Club home page Giter Club logo

python-package-template's Introduction

Build CodeQL

Python Package Template

Template of Python project wrapped as package that can be easily uploaded to PyPi

Getting Started

To use this template click "Use this template" and create a new repository or open the template in a codespace or use this template here

Usage

Create virtual environment and install dependencies:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

After that you would adapt the code and continue when the project is ready to be published. Build the package using:

python setup.py sdist bdist_wheel

Test compiled package locally using:

pip install dist/package-xx.whl

Before publishing to PyPi create account and get API key. Save API key in your session using:

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=$actual_token

Publish the package to PyPi:

twine upload dist/*

python-package-template's People

Contributors

mldxo 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.