Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/1313e/python-package-tutorial

A tutorial on how to build a Python package

https://github.com/1313e/python-package-tutorial

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.4%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

A tutorial on how to build a Python package

Basic Info
  • Host: GitHub
  • Owner: 1313e
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 57.6 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created over 7 years ago · Last pushed over 7 years ago
Metadata Files
Readme License

README.rst 

TuPy: A tutorial on how to build a Python package
=================================================
This repo contains several tutorials/descriptions on how to build a Python package.
Many of the descriptions that are given come from my own personal experience in building several Python packages.
Therefore, they are in no way guaranteed to be the best way of doing certain things, but what I figured is the easiest way.

I also highly recommend using the `Spyder`_ editor when making packages, since it has many features that make it much easier to keep everything ordered and structured.
For the same reason, using `Anaconda`_ and setting up different environments (like, a development and a testing environment) make it easier to keep package building separated from your usual work.
This also means, that I refuse to use Jupyter notebooks in this repo, as they are by far the worst way of using Python ever.

Sometimes, I refer in the documentation, comments or TUTORIALs to specific PEPs (or Python Enhancement Proposals).
These define the specific rules that are associated with certain Pythonic styles (like :PEP:`8` for code lay-outs or :PEP:`440` for version identifiers) or additions that have been made to the Python language.
They can be checked `here`_.

.. _Spyder: https://www.spyder-ide.org
.. _Anaconda: https://www.anaconda.com
.. _here: https://www.python.org/dev/peps

Owner

  • Name: Ellert van der Velden
  • Login: 1313e
  • Kind: user
  • Location: Houten
  • Company: Energyworx

Software engineer. Open-source contributor and colormap designer. | "Programming is the art of reducing a big problem to a list of manageable steps." ― 1313e

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • 1313e (1)
Top Labels
Issue Labels
Pull Request Labels