Skip to main content

irelease

Python PyPI Version Docs License Forks Open Issues Project Status Downloads Downloads GitHub repo size Donate

Release your library by using the command: irelease or pyrelease

Star this repo if you like it! ⭐️

Introduction

irelease is Python package that will help to release your python package on both github and pypi. A new release of your package is created by taking the following steps:

  1. Extract the version from the init.py file

  2. Remove old build directories such as dist, build and x.egg-info

  3. Git pull (to make sure all is up to date)

  4. Get latest release version at github

  5. Check if the local (current) version is newer then the latest github release.

     1. Make new wheel, build and install package
     2. Set tag to newest version
     3. Push to git
     4. Upload to pypi (credentials for pypi required)
    

Installation

  • Install irelease from PyPI (recommended). irelease is compatible with Python 3.6+ and runs on Linux, MacOS X and Windows.
  • It is distributed under the MIT license.

Quick Start

pip install irelease

Alternatively, install irelease from the GitHub source:

git clone https://github.com/erdogant/irelease.git
cd irelease
python setup.py install

Run irelease

Go to the directory where the package is you want to release and simply run release:

$ irelease

The following arguments are availble:

# Github name
irelease -u <githubname>

# Package name your want to release
irelease -p <packagename>

# Removing local builds:
# 1: Yes
# 0: No
irelease -c 1

# Verbosity messages:
# 0: No messages
# 1: Error only
# 2: Warnings and above
# 3: Regular messages and above
# 4: Debug and above
# 5: Trace and above
irelease -v 5

# Twine path for to irelease at pypi. This is automatically determined if standard installation is performed.
irelease -t 'C://<username>/AppData/Roaming/Python/Python36/Scripts/twine.exe'

Example:

Your package to-be-published must have the correct structure. At least these files and folders are expected:

    <any_dirname>/
    ├── <package_dir>/
       ├── __init__.py
       ├── package_name.py
       ├── ...
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    ├── requirements.txt
    ├── setup.py
    └── ...

Example: releasing bnlearn package.

    bnlearn/
    ├── bnlearn/
       ├── __init__.py
       ├── bnlearn.py
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    ├── requirements.txt
    ├── setup.py

Go to your destination dir and run release:

$ irelease

release with your specified arguments

# Package can be specified:
$ bnlearn>irelease -p bnlearn

# Username can be specified:
$ bnlearn>irelease -u erdogant

# Cleaning of previous builds in directory can be disabled
$ bnlearn>irelease -c 0

Do not forget to enter some release information on github and mark your release number:

Maintainer

  • Erdogan Taskesen, GitHub: erdogant
  • Contributions are welcome.
  • Yes! This library is entirely free, but it runs on coffee! :) Feel free to support with a Coffee.

Buy me a coffee

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

irelease-1.3.4.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

irelease-1.3.4-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file irelease-1.3.4.tar.gz.

File metadata

  • Download URL: irelease-1.3.4.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.14

File hashes

Hashes for irelease-1.3.4.tar.gz
Algorithm Hash digest
SHA256 53f75d691fa0388b329c9fe6b2abc36b49b274cda8b87809088226f7133ca0f3
MD5 29c32eef84ed0b3f69d5735ae3256e67
BLAKE2b-256 c4496e749243ae500f7c60e720aa41db08a29414ecf84266503169a96e40809f

See more details on using hashes here.

File details

Details for the file irelease-1.3.4-py3-none-any.whl.

File metadata

  • Download URL: irelease-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.14

File hashes

Hashes for irelease-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 723417147189c409c79d62d88ba0d29322bd886d66845720475d4bd305265e14
MD5 e180fc9db45ac949ad8fccc021189794
BLAKE2b-256 07618f05101c74d2637e748079eaf0c8c67ad518af27db9a02023144e478438c

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.3.4 This release

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page