Skip to main content

A small example package

Project description

Make sure you have upgraded version of pip

Windows

py -m pip install --upgrade pip

Linux/MAC OS

python3 -m pip install --upgrade pip

Create a project with the following structure

packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.cfg
├── src/
│   └── example_package/
│       ├── __init__.py
│       └── example.py
└── tests/
touch LICENSE
touch pyproject.toml
touch setup.cfg
mkdir src/mypackage
touch src/mypackage/__init__.py
touch src/mypackage/main.py
mkdir tests

pyproject.toml

This file tells tools like pip and build how to create your project

[build-system]
requires = [
    "setuptools>=42",
    "wheel"
]
build-backend = "setuptools.build_meta"

build-system.requires gives a list of packages that are needed to build your package. Listing something here will only make it available during the build, not after it is installed.

build-system.build-backend is the name of Python object that will be used to perform the build. If you were to use a different build system, such as flit or poetry, those would go here, and the configuration details would be completely different than the setuptools configuration described below.

Setup.cfg setup

Using setup.cfg is a best practice, but you could have a dynamic setup file using setup.py

[metadata]
name = example-pkg-YOUR-USERNAME-HERE
version = 0.0.1
author = Example Author
author_email = author@example.com
description = A small example package
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/pypa/sampleproject
project_urls =
    Bug Tracker = https://github.com/pypa/sampleproject/issues
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent

[options]
package_dir =
    = src
packages = find:
python_requires = >=3.6

[options.packages.find]
where = src

Running the build

Make sure your build tool is up to date

Windows

py -m pip install --upgrade build

Linux/MAC OS

python3 -m pip install --upgrade build

Create the build

py -m build

References

https://packaging.python.org/tutorials/packaging-projects/

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

ntlm-auth-md5-0.0.1.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

ntlm_auth_md5-0.0.1-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file ntlm-auth-md5-0.0.1.tar.gz.

File metadata

  • Download URL: ntlm-auth-md5-0.0.1.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for ntlm-auth-md5-0.0.1.tar.gz
Algorithm Hash digest
SHA256 940ec5f87379b89292cff392c2367967a8372151828cfa253c11e8b16f3e3bb9
MD5 2b8d739b3d60c11708634abf73882780
BLAKE2b-256 f915b8789ff203a532ddb0b2a31cf9ded6fcd592b961310a78822dd2cf33df86

See more details on using hashes here.

File details

Details for the file ntlm_auth_md5-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ntlm_auth_md5-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c7b4f49e83140fb8a4cb626c75bd0d2853a9246f7c1c7a7a445e5db66acc0eff
MD5 00c4927b7017e7d23c188aca7a378b5b
BLAKE2b-256 4301e153aa86dfbb7646492d84a5018eb0ea2d93c7d9abce0910c798bce5aaf7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page