A tool to manage your PyPI package.
Project description
pipackager
___ _____ ___ _
/ _ \\_ \/ _ \__ _ ___| | ____ _ __ _ ___ _ __
/ /_)/ / /\/ /_)/ _` |/ __| |/ / _` |/ _` |/ _ | '__|
/ ___/\/ /_/ ___| (_| | (__| | (_| | (_| | __| |
\/ \____/\/ \__,_|\___|_|\_\__,_|\__, |\___|_|
|___/
Created by rUv
pipackager
is a comprehensive tool designed to manage your PyPI package, simplifying tasks such as cleaning old distributions, building new ones, uploading to PyPI, version incrementing, and more.
Installation
To install pipackager
, use pip:
pip install pipackager
Usage
You can start the tool by running:
pipackager
This will launch an interactive menu that allows you to manage your PyPI packages with ease.
Features
Main Features
-
Clean Old Distributions:
- Removes old distribution files from the
dist
directory.
- Removes old distribution files from the
-
Build New Distributions:
- Builds new distribution files (source and wheel) using
setuptools
.
- Builds new distribution files (source and wheel) using
-
Upload Distributions to PyPI:
- Uploads the built distributions to PyPI using
twine
.
- Uploads the built distributions to PyPI using
-
Increment Version Number:
- Patch: Increments the patch version number (e.g., 0.1.0 -> 0.1.1).
- Minor: Increments the minor version number (e.g., 0.1.0 -> 0.2.0).
- Major: Increments the major version number (e.g., 0.1.0 -> 1.0.0).
-
Help Overview:
- Provides an overview of the features and options of the tool.
Advanced Options
-
Create/Update GitHub Actions Workflow:
- Creates or updates a GitHub Actions workflow configuration file to automate build, test, and deployment processes.
-
Run Tests Using Pytest:
- Executes tests using
pytest
to ensure your package is working as expected.
- Executes tests using
-
Lint and Format Code:
- Lints your code using
flake8
and formats it usingblack
.
- Lints your code using
-
Check and Update Dependencies:
- Checks for outdated dependencies and updates them to the latest versions.
-
Generate Start Command:
- Generates a start command for your library, allowing you to execute it easily from the command line.
Environment Variables
pipackager
requires the following environment variables for uploading distributions to PyPI:
TWINE_USERNAME
: Your PyPI username.TWINE_PASSWORD
: Your PyPI password or token.
If these variables are not set, pipackager
will prompt you to enter them and will export them for you.
Example Workflow
Here is an example workflow of using pipackager
to manage your PyPI package:
-
Clean Old Distributions:
- Select option
1
to remove old distribution files.
- Select option
-
Build New Distributions:
- Select option
2
to build new distribution files.
- Select option
-
Increment Version Number:
- Select option
4
,5
, or6
to increment the version number (patch, minor, or major).
- Select option
-
Upload Distributions to PyPI:
- Select option
3
to upload the new distribution files to PyPI.
- Select option
-
Advanced Options:
- Select option
7
to access advanced options such as creating/updating GitHub workflows, running tests, linting and formatting code, checking and updating dependencies, or generating a start command.
- Select option
Help
To view a detailed help overview, select option 8
from the main menu.
License
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
pipackager
is designed to streamline the process of managing and deploying your Python packages to PyPI, making it easier to maintain high-quality, well-tested, and properly versioned software.
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file pipackager-0.3.0.tar.gz
.
File metadata
- Download URL: pipackager-0.3.0.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec024c4980831d98e2b7c4de4337787be6256de09907420c16122380ab390f08 |
|
MD5 | 95c7fdcd327f9f2b522a4ee54e6e7b19 |
|
BLAKE2b-256 | 6ac99aaa3c2302037a442ed96dcc27a668a20999d537e67d75a890e20f5b8df2 |
File details
Details for the file pipackager-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: pipackager-0.3.0-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c48c0d5e60fadbcb8f8095748961faaeddf9977269ce9fec2b5137732daebf7f |
|
MD5 | 7a681d29ba9908c64010b854eb4f66a9 |
|
BLAKE2b-256 | c55a9142e9edb0f3de43246e111d1ad9896ef571526af8f106b0ffcd0db81543 |