https://github.com/animenosekai/packageupload
An easy PyPI package uploader
https://github.com/animenosekai/packageupload
Last synced: 4 months ago
JSON representation
An easy PyPI package uploader
- Host: GitHub
- URL: https://github.com/animenosekai/packageupload
- Owner: Animenosekai
- License: mit
- Created: 2020-06-01T22:23:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-06T16:12:41.000Z (almost 5 years ago)
- Last Synced: 2025-02-04T05:16:39.044Z (5 months ago)
- Language: Python
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PackageUpload
### **The most easy way to upload your packages to PyPI!**
[](https://pypi.org/project/packageupload/)
[](https://pypistats.org/packages/packageupload)
[](https://pypi.org/project/packageupload/)
[](https://pypi.org/project/packageupload/)
[](https://github.com/Animenosekai/packageupload/blob/master/LICENSE)
[](https://github.com/Animenosekai/packageupload/issues)
[](https://github.com/Animenosekai/packageupload)
## Table of Content
- [Installation](#installation)
- [What is PackageUpload?](#whatis)
- [Usage](#usage)
- [Development](#development)
- [Legals](#legals)
## Installation
You can install this library with **`PIP`**, the Python Package Manager
Simply type `pip install packageupload` in your terminal/command-line prompt.
> This library has four third-pary dependencies installed automatically with `pip install packageupload`.
## What is PackageUpload?
It is a simple python script that will help you upload your packages on PyPI (because it's boring to build setup.py and upload it manually)
> You just have to launch `packageupload` from your command-prompt/terminal!
## Usage
---
### PREREQUISITE
**You first need to create a repository for your package on GitHub and to upload it to GitHub.**
**Then you need to create a release for this repository.**
**You also need a PyPI account (obviously)**
---
### Instructions
#### Open the package directory in your command-prompt (or `cd`to it).
#### Run `packageupload`
---
### Options
#### Usage
- `packageupload `
#### Available Options
- `nocleanup`: To leave everything without cleaning up the directory to its first state.
- `keepsetup`: To leave the setup.py file (not needed if nocleanup)
- `customclassifiers`: To add custom classifiers to your setup file
- `customurl`: To add a the website URL for the package (if you want something other than the GitHub Repository)
- `customsetup`: If you want to customize your setup with other sections (i.e. entry_points, ...)
---
### Functions
- **`start(keepsetup, nocleanup, customclassifiers, customurl)`**
**It will guide you and help you upload your packages on PyPI**
Arguments:
cleanup (optional, default: True): Wether you want to clean and keep the directory as if nothing happened after uploading the package to PyPI (> bool)
keepsetup (optional, default: False): Wether you want to keep setup.py after the upload is done or not (not needed if cleanup = False). (> bool)
customclassifiers (optional, default: True): Wether you want to add custom classifiers or not. (> bool)
customurl (optional, default: False): Wether you have a website other than the GitHub repo for the package and that you to add it. (> bool)
upgrade (optional, default: False): If True, it will not check the availability of the name.
> Returns 0 if everything is fine and uploaded correctly to PyPI
> Returns 1 if an error occured while cleaning the package directory
> Returns 2 if an error occured while uploading the package.
> Returns 3 if an error occured while building the package.
> Returns 4 if an error occured while verifying the module/packaging the module.
> Returns 5 if an error occured while creating the setup file.
> Returns 6 if you aborted.
> Returns 7 if an error occured while downloading the package with `pip`
---
- **`setup(customurl)`**
**Creates a setup.py file.**
Arguments:
customurl (optional, default: False): Wether you have a website other than the GitHub repo for the package and that you to add it. (> bool).
upgrade (optional, default: False): If True, it will not check the availability of the name.
> Returns 0 if success 1 if failed (> integer)
---
- **`module_verification()`**
**To package the module and its files.**
Arguments:
there is no argument to pass.
> Returns 0 if success, 1 if failed (> integer)
---
- **`build()`**
**To build the package.**
Arguments:
there is no argument to pass.
> Returns 0 if success, 1 if failed (> integer)
---
- **`upload()`**
**To upload a built package to PyPI.**
Arguments:
there is no argument to pass.
> Returns 0 if success, 1 if failed (> integer)
---
- **`clean(keepsetup)`**
**Cleans the package directory.**
Arguments:
keepsetup (optional, default: False): Wether you want to keep setup.py or not. (> bool)
> Returns 0 if success, 1 if failed (> integer)
---
- **`download()`**
**Installs the package using `pip`.**
Arguments:
there is no argument to pass.
> Returns 0 if success, 1 if failed (> integer)
---
## Development
PackageUpload is in constant development and fixes are made on a regular basis (but I also try to add some new features ehe)
#### If you have any issues, questions, development problem: feel free to ask in the issues section.
If you want to help us and join me here is a quick guide.
### Files
`__init.py__` is the main module
`README.md` is the text file you're currently reading, with all the documentations and explanations.
`LICENSE` is a text file with File Center's license
#### Dependencies
The File Center Library has four third-party dependencies.
- `twine`
- `setuptools`
- `filecenter`
- `lifeeasy`
*(`filecenter`and `lifeeasy` are both written by me)*
SetupTools is used to make build the package.
Twine is used to safely upload the package.
FileCenter is used to check files.
LifeEasy is used to make my life easier.
## Copyrights and Legals
**If you think that there is any kind of copyright infrigements, feel free to ask me to remove it and I will try to do so as soon as possible**
**GitHub** is a brand which belongs to GitHub, Inc. (Microsoft)
**Python** belongs to the Python Software Foundation
> ©Anime no Sekai - 2020 ✨