<p>
<div align="center">
<h1>
magzdb - magzdb.org Downloader<br /> <br />
<a href="https://pypi.python.org/pypi/magzdb">
<img
src="https://img.shields.io/pypi/v/magzdb.svg"
alt="Python Package"
/>
</a>
<a href="https://pypi.python.org/pypi/magzdb">
<img
src="https://github.com/skyme5/magzdb/actions/workflows/continuous-integration-pip.yml/badge.svg"
alt="CI"
/>
</a>
<a href="https://codecov.io/gh/skyme5/magzdb">
<img
src="https://img.shields.io/codecov/c/github/skyme5/magzdb"
alt="Code Coverage"
/>
</a>
<a href="https://codecov.io/gh/skyme5/magzdb">
<img
src="https://img.shields.io/pypi/pyversions/magzdb?cacheSeconds=3600"
alt="Python Versions"
/>
</a>
<a href="https://github.com/psf/black">
<img
src="https://img.shields.io/badge/code%20style-black-000000.svg"
alt="The Uncompromising Code Formatter"
/>
</a>
<a href="https://pepy.tech/project/magzdb">
<img
src="https://static.pepy.tech/badge/magzdb"
alt="Monthly Downloads"
/>
</a>
<a href="https://opensource.org/licenses/MIT">
<img
src="https://img.shields.io/badge/License-MIT-blue.svg"
alt="License: MIT"
/>
</a>
</h1>
<a href="https://buymeacoffee.com/skyme5" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;" ></a>
</div>
</div>
</p>
### Installation
Install using pip
```bash
$ pip install -U magzdb
```
### Usage
```text
usage: magzdb [-h] [-V] -i MAGAZINE_ID [-e [EDITION [EDITION ...]]]
[-f FILTER] [-l] [-P DIRECTORY_PREFIX] [--downloader DOWNLOADER]
[--debug]
Magzdb.org Downloader
required arguments:
-i MAGAZINE_ID, --id MAGAZINE_ID
ID of the Magazine to Download. eg. http://magzdb.org/j/<ID>.
optional arguments:
-h, --help show this help message and exit
-V, --version Print program version and exit
-e [EDITION [EDITION ...]], --editions [EDITION [EDITION ...]]
Select Edition
-f FILTER, --filter FILTER
Use filter. See README#Filters
-l, --latest Download only latest edition.
-P DIRECTORY_PREFIX, --directory-prefix DIRECTORY_PREFIX
Download directory.
--downloader DOWNLOADER
Use External downloader (RECOMMENDED). Currently supported: aria2, wget, curl
--debug Print debug information.
--skip-download Don't download files.
```
### Usage Examples
#### Docker
```bash
docker build . -t magzdb
docker run -v $(PWD):/tmp magzdb -h
# Add alias to shell
alias magzdb="docker run -v $(PWD):/tmp magzdb"
magzdb -h
```
#### Download all editions
```bash
$ magzdb -i 1826
```
#### Filters
You can supply filter using `-f`, for example to download issues between
`4063895` and `4063901`, you can write as
```bash
$ magzdb -i 1826 -f "eid > 4063895 and eid < 4063901"
```
You can use `eid`, `year` in the filter expression.
##### More examples of filter expression
- `eid > 4063895 and eid < 4063901` or `eid >= 4063895 and eid <= 4063901`
- `eid >= 4063895` or `eid != 4063895`
- `year >= 2018`, `year <= 2018`, `year == 2018` or even `year != 2018`
#### Download only latest edition
```bash
$ magzdb -i 1826 -l
```
#### Download only latest edition with custom location `magazine`
```bash
$ magzdb -i 1826 -l -P magazine
```
#### Use external downloader
```bash
$ magzdb -i 1826 -l -P magazine --downloader wget
```
> This is recommended since internal downloader does not support resuming interrupted downloads.
### Python Installation Recommendation
If you don't want to install official [Python](https://www.python.org/downloads/) to your system (global).
You can install [pyenv installer](https://github.com/pyenv/pyenv-installer) environment under your specific account. It's prefered method for macOS users, because High Sierra and later macOS ships with old Python 2.7.10.
## Contributing
Found a bug or missing a feature you are more than welcome to contribute.
<a href="https://github.com/skyme5/magzdb/graphs/contributors">
<img src="https://contrib.rocks/image?repo=skyme5/magzdb" />
</a>
## License
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/skyme5/magzdb",
"name": "magzdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "magzdb",
"author": "Aakash Gajjar",
"author_email": "skyqutip@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/88/33/e3c0dd5a1f02d6851a759717c7865fac9e6a07fd3995060a5a78d0e30f04/magzdb-1.2.0.tar.gz",
"platform": null,
"description": "<p>\n <div align=\"center\">\n <h1>\n magzdb - magzdb.org Downloader<br /> <br />\n <a href=\"https://pypi.python.org/pypi/magzdb\">\n <img\n src=\"https://img.shields.io/pypi/v/magzdb.svg\"\n alt=\"Python Package\"\n />\n </a>\n <a href=\"https://pypi.python.org/pypi/magzdb\">\n <img\n src=\"https://github.com/skyme5/magzdb/actions/workflows/continuous-integration-pip.yml/badge.svg\"\n alt=\"CI\"\n />\n </a>\n <a href=\"https://codecov.io/gh/skyme5/magzdb\">\n <img\n src=\"https://img.shields.io/codecov/c/github/skyme5/magzdb\"\n alt=\"Code Coverage\"\n />\n </a>\n <a href=\"https://codecov.io/gh/skyme5/magzdb\">\n <img\n src=\"https://img.shields.io/pypi/pyversions/magzdb?cacheSeconds=3600\"\n alt=\"Python Versions\"\n />\n </a>\n <a href=\"https://github.com/psf/black\">\n <img\n src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\n alt=\"The Uncompromising Code Formatter\"\n />\n </a>\n <a href=\"https://pepy.tech/project/magzdb\">\n <img\n src=\"https://static.pepy.tech/badge/magzdb\"\n alt=\"Monthly Downloads\"\n />\n </a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img\n src=\"https://img.shields.io/badge/License-MIT-blue.svg\"\n alt=\"License: MIT\"\n />\n </a>\n </h1>\n <a href=\"https://buymeacoffee.com/skyme5\" target=\"_blank\"><img src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;\" ></a>\n </div>\n </div>\n</p>\n\n### Installation\n\nInstall using pip\n\n```bash\n$ pip install -U magzdb\n```\n\n\n### Usage\n\n```text\nusage: magzdb [-h] [-V] -i MAGAZINE_ID [-e [EDITION [EDITION ...]]]\n [-f FILTER] [-l] [-P DIRECTORY_PREFIX] [--downloader DOWNLOADER]\n [--debug]\n\nMagzdb.org Downloader\n\nrequired arguments:\n -i MAGAZINE_ID, --id MAGAZINE_ID\n ID of the Magazine to Download. eg. http://magzdb.org/j/<ID>.\n\noptional arguments:\n -h, --help show this help message and exit\n -V, --version Print program version and exit\n -e [EDITION [EDITION ...]], --editions [EDITION [EDITION ...]]\n Select Edition\n -f FILTER, --filter FILTER\n Use filter. See README#Filters\n -l, --latest Download only latest edition.\n -P DIRECTORY_PREFIX, --directory-prefix DIRECTORY_PREFIX\n Download directory.\n --downloader DOWNLOADER\n Use External downloader (RECOMMENDED). Currently supported: aria2, wget, curl\n --debug Print debug information.\n --skip-download Don't download files.\n```\n\n### Usage Examples\n\n#### Docker\n\n```bash\ndocker build . -t magzdb\ndocker run -v $(PWD):/tmp magzdb -h\n\n# Add alias to shell\nalias magzdb=\"docker run -v $(PWD):/tmp magzdb\"\nmagzdb -h\n```\n\n#### Download all editions\n\n```bash\n$ magzdb -i 1826\n```\n\n#### Filters\n\nYou can supply filter using `-f`, for example to download issues between\n`4063895` and `4063901`, you can write as\n\n```bash\n$ magzdb -i 1826 -f \"eid > 4063895 and eid < 4063901\"\n```\n\nYou can use `eid`, `year` in the filter expression.\n\n##### More examples of filter expression\n\n- `eid > 4063895 and eid < 4063901` or `eid >= 4063895 and eid <= 4063901`\n- `eid >= 4063895` or `eid != 4063895`\n- `year >= 2018`, `year <= 2018`, `year == 2018` or even `year != 2018`\n\n#### Download only latest edition\n\n```bash\n$ magzdb -i 1826 -l\n```\n\n#### Download only latest edition with custom location `magazine`\n\n```bash\n$ magzdb -i 1826 -l -P magazine\n```\n\n#### Use external downloader\n\n```bash\n$ magzdb -i 1826 -l -P magazine --downloader wget\n```\n\n> This is recommended since internal downloader does not support resuming interrupted downloads.\n\n### Python Installation Recommendation\n\nIf you don't want to install official [Python](https://www.python.org/downloads/) to your system (global).\nYou can install [pyenv installer](https://github.com/pyenv/pyenv-installer) environment under your specific account. It's prefered method for macOS users, because High Sierra and later macOS ships with old Python 2.7.10.\n\n## Contributing\n\nFound a bug or missing a feature you are more than welcome to contribute.\n\n<a href=\"https://github.com/skyme5/magzdb/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=skyme5/magzdb\" />\n</a>\n\n## License\n\nMIT\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Magzdb.org Downloader",
"version": "1.2.0",
"split_keywords": [
"magzdb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42a561c36c86526eefa726bc2e7a776ab0312059a704526c6913eb72efa6ce43",
"md5": "65b284621a4b10c194eb5c1db29ff410",
"sha256": "bcb96d9e7eea06aa77124bd1a0e7a9cee2d317ec27b59c62e10518be818d1216"
},
"downloads": -1,
"filename": "magzdb-1.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "65b284621a4b10c194eb5c1db29ff410",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 9062,
"upload_time": "2023-02-01T19:43:08",
"upload_time_iso_8601": "2023-02-01T19:43:08.622556Z",
"url": "https://files.pythonhosted.org/packages/42/a5/61c36c86526eefa726bc2e7a776ab0312059a704526c6913eb72efa6ce43/magzdb-1.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8833e3c0dd5a1f02d6851a759717c7865fac9e6a07fd3995060a5a78d0e30f04",
"md5": "57a1d22e50414c07035ade310384e440",
"sha256": "c1267735631f8a8884074ec90d187f43ed3f5417deed89612f4ac2d7012d7ab7"
},
"downloads": -1,
"filename": "magzdb-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "57a1d22e50414c07035ade310384e440",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 11312,
"upload_time": "2023-02-01T19:43:10",
"upload_time_iso_8601": "2023-02-01T19:43:10.302690Z",
"url": "https://files.pythonhosted.org/packages/88/33/e3c0dd5a1f02d6851a759717c7865fac9e6a07fd3995060a5a78d0e30f04/magzdb-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 19:43:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "skyme5",
"github_project": "magzdb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "magzdb"
}
JSON
