A small example package
Project description
Example Package
This is a simple example package. You can use Github-flavored Markdown to write your content.
Setup
$ git clone
To install the package locally:
$ make install
To build the wheels and source distributions files:
$ make build
To upload the builded package to PyPI:
$ make upload
In order to build and upload sequentially, you should just:
$ make pypi
Usage
from example_package_joaopcnogueira import example
example.add_one(10)
for the CLI interface, just go:
$ python -m example_package_joaopcnogueira --add-two 20
Package Structure
example_package_joaopcnogueira/
- The package folder, within it there is the python modules.
example_package_joaopcnogueira/__init__.py
- File that indicates that the folder
example_package_joaopcnogueira
is a package
example_package_joaopcnogueira/example.py
- Python module
pyproject.toml
- File that contains metadata information about the package and how to build it. It's the current recommendation instead of setup.py
README.md
- This actual file, where we put information about the package to be read by humans.
.gitignore
- Git special file which indicates what files and folders should not be tracked by git.
Makefile
- A configuration file which handles command line utilities on how to install, build and upload the project to PyPI.
notebooks/
- Folder where notebooks files exists.
tests/
- Folder where the tests code exists.
References
Packaging Python Projects from PyPA - Python Project Authority
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for example_package_joaopcnogueira-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8add9f9464c578f7df9672a683a7ae3f7e223f8d0e06b65a733fa7a2687059b |
|
MD5 | 152effa0821888381552cd8081454811 |
|
BLAKE2b-256 | 31a829e8b73de13305e4ce45ef2affd619548441a4632cc19a8303bd15fb0291 |
Close
Hashes for example_package_joaopcnogueira-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e15088f581cad6f1e52ca10d0907b390e23bed0f593d341d6a5a3735822a0d1a |
|
MD5 | 5f012988c58a6578cc61eeaa36ca43fd |
|
BLAKE2b-256 | e06810dcf15f7f05e68938d1c2c8c3f3758fc5a30380503935f64dc86f933521 |