Skip to content

Commit

Permalink
Minor edits (#75)
Browse files Browse the repository at this point in the history
* doc : pypi badge bug fixed

* doc : repo-size badge added to README.md

* doc : warning --> info

* fix : setup.py keywords updated

* fix : --test argument default value set to False

* doc : AUTHORS.md updated

* doc : CHANGELOG.md updated

* doc : white-space bug in README.md fixed
  • Loading branch information
sepandhaghighi authored Dec 8, 2024
1 parent 003c527 commit 5b295f4
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
7 changes: 5 additions & 2 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Core Developers

----------
- AmirHosein Rostami - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
- Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
Expand All @@ -8,4 +7,8 @@

# Other Contributors
----------
- Amir Boreshnavard ([Telegram](https://t.me/ABoreshnavard))
- [@boreshnavard](https://github.com/boreshnavard) ++
- [@sadrasabouri](https://github.com/sadrasabouri)


++ Graphic designer
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- `ReserverBaseError` added in `reserver/__init__.py`
### Changed
- `README.md` updated
- `AUTHORS.md` updated
- GitHub actions are limited to the `dev` and `main` branches
- `generate_template_setup_py` method in `reserver_func.py`
- `Python 3.13` added to `test.yml`
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
<br/>
<br/>
<a href="https://codecov.io/gh/openscilab/reserver"><img src="https://codecov.io/gh/openscilab/reserver/branch/main/graph/badge.svg" alt="Codecov"/></a>
<a href="https://badge.fury.io/py/reserver"><img src="https://badge.fury.io/py/reserver.svg" alt="PyPI version" height="18"></a>
<a href="https://badge.fury.io/py/reserver"><img src="https://badge.fury.io/py/reserver.svg" alt="PyPI version"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
<a href="https://github.com/openscilab/reserver"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/reserver"></a>
<a href="https://discord.gg/RD2y6SGuY3"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>
</div>

Expand Down Expand Up @@ -83,7 +84,7 @@ uploader = PyPIUploader(TEST_PYPI_TOKEN, test_pypi=True)
uploader.batch_upload(["PACKAGE_NAME_1", "PACKAGE_NAME_2"], ["config1.json", "config2.json"])
```
### CLI
⚠️ You can use `reserver` or `python -m reserver` to run this program
ℹ️ You can use `reserver` or `python -m reserver` to run this program
#### Version
```console
reserver -v
Expand Down Expand Up @@ -134,7 +135,7 @@ reserver --name sample_name1 sample_name2 --param name1_param.json name2_param.j

Choose the method that best suits your needs. Using a single `param.json` is efficient for packages with similar information, while separate files offer more granular control.

⚠️ You can use all available features on both `pypi.org` and `test.pypi.org`.
ℹ️ You can use all available features on both `pypi.org` and `test.pypi.org`.
## Issues & bug reports

Just fill an issue and describe it. We'll check it ASAP! or send an email to [[email protected]](mailto:[email protected] "[email protected]").
Expand Down
2 changes: 1 addition & 1 deletion reserver/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def main():
metavar="(TEST.PYPI|PYPI)_TOKEN",
help='The token for (main|test) PyPI account',
)
parser.add_argument('--test', action='store_true', help='test PyPI (test.pypi.org)')
parser.add_argument('--test', action='store_true', help='test PyPI (test.pypi.org)', default=False)
parser.add_argument('--version', help="version", action='store_true', default=False)
parser.add_argument('-v', help="version", action='store_true', default=False)
args = parser.parse_known_args()[0]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def read_description():
author_email='[email protected]',
url='https://github.com/openscilab/reserver',
download_url='https://github.com/openscilab/reserver/tarball/v0.3',
keywords="python3 python PyPI pip package name reservation",
keywords="pypi pip package name reserve reserver reservation python",
project_urls={
'Source': 'https://github.com/openscilab/reserver',
},
Expand Down

0 comments on commit 5b295f4

Please sign in to comment.