irelease
Library that automates releasing your Github python package at Pypi.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Keywords
Repository
Library that automates releasing your Github python package at Pypi.
Basic Info
- Host: GitHub
- Owner: erdogant
- License: other
- Language: Python
- Default Branch: master
- Homepage: https://erdogant.github.io/irelease
- Size: 7.09 MB
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 26
Topics
Metadata Files
README.md
irelease
<!---
-->
<!---
-->
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:
- Extract the version from the init.py file
- Remove old build directories such as dist, build and x.egg-info
- Git pull (to make sure all is up to date)
- Get latest release version at github
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
bash
pip install irelease
Alternatively, install irelease from the GitHub source:
bash
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:
bash
$ irelease
The following arguments are availble: ```bash
Github name
irelease -u
Package name your want to release
irelease -p
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://
Example:
Your package to-be-published must have the correct structure. At least these files and folders are expected:
bash
<any_dirname>/
├── <package_dir>/
│ ├── __init__.py
│ ├── package_name.py
│ ├── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── ...
Example: releasing bnlearn package.
bash
bnlearn/
├── bnlearn/
│ ├── __init__.py
│ ├── bnlearn.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
Go to your destination dir and run release:
bash
$ irelease
release with your specified arguments ```bash
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:
References
- https://github.com/erdogant/irelease
Maintainer
Owner
- Name: Erdogan
- Login: erdogant
- Kind: user
- Location: Den Haag
- Website: https://erdogant.github.io/
- Repositories: 51
- Profile: https://github.com/erdogant
Machine Learning | Statistics | Bayesian | D3js | Visualizations
Citation (CITATION.cff)
# YAML 1.2
---
authors:
-
family-names: Taskesen
given-names: Erdogan
orcid: "https://orcid.org/0000-0002-3430-9618"
cff-version: "1.1.0"
date-released: 2020-02-02
keywords:
- "python"
- "release"
- "pypi"
- "release-automation"
- "github-release"
license: "MIT"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/erdogant/irelease"
title: "Python package to release your package."
version: "0.1.0"
...
GitHub Events
Total
- Release event: 2
- Push event: 3
- Create event: 3
Last Year
- Release event: 2
- Push event: 3
- Create event: 3
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 110
- Total Committers: 2
- Avg Commits per committer: 55.0
- Development Distribution Score (DDS): 0.491
Top Committers
| Name | Commits | |
|---|---|---|
| erdogant | e****t@g****m | 56 |
| Erdogan Taskesen | 3****t@u****m | 54 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 199 last-month
- Total dependent packages: 0
- Total dependent repositories: 8
- Total versions: 26
- Total maintainers: 1
pypi.org: irelease
irelease is an Python package to release your package to Pypi.
- Homepage: https://erdogant.github.io/irelease
- Documentation: https://irelease.readthedocs.io/
- License: other
-
Latest release: 1.3.2
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- pytest * development
- rst2pdf * development
- sphinx * development
- sphinx_rtd_theme * development
- spyder-kernels ==2.1. development
- numpy *
- packaging *
- setuptools *
- twine *
- wheel *
- build *
- numpy *
- packaging *
- toml *
- twine *