medisch-contact-downloader


Namemedisch-contact-downloader JSON
Version 0.2.5 PyPI version JSON
download
home_pagehttps://gitlab.com/fvdbeek/medisch-contact-downloader
SummaryDownload Medisch Contact and convert to EPUB
upload_time2023-03-25 17:23:36
maintainer
docs_urlNone
authorFolkert van der Beek
requires_python>=3.8
licenseMIT License
keywords medisch contact download epub
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Download Medisch Contact and convert to EPUB

> A command line tool and lib to download Medisch Contact and convert to EPUB

## Introduction

[Medisch Contact](https://www.medischcontact.nl/) is a Dutch magazine for medical doctors.

This package provides a Python libary and command line tool for convenient downloading of the online contents to EPUB files.

* Free software: MIT license


## Installation

If you have Python on your system you can do the usual:

    $ pip install medisch-contact-downloader


## Quickstart

### Command line usage examples

List all issues in the current year. For listing only, no authentication is required.

    $ medisch-contact-downloader -l

List all issues in the years 2002, 2004, 2006, 2007, and 2008:

    $ medisch-contact-downloader -l -y 2002 2004 2006-2008

Download the latest issue to the default download-directory. For downloading, a username and password is required for authentication.

    $ medisch-contact-downloader -u username -p password -d


Download the issues with the IDs 2022-4 and 2022-5 to the ~/Downloads download-directory. An ID is composed of the year and number of the issue.

    $ medisch-contact-downloader -u username -p password -d -i 2022-4 2022-5 -w ~/Downloads

Email the latest issue:

    $ medisch-contact-downloader -e -u username -p password --smtp_host smtp.example.com --smtp_port 587 --smtp_username user@example.com --smtp_password <password> --sender user@example.com --recipient info@example.com

Show command line help::

    $ medisch-contact-downloader -h


## Configuration File

The configuration file `config.ini` can change the default values for command line options. It should be written using a standard INI style. The keys should be grouped into sections. For now, the name of the sections are ignored. The section name appears on a line by itself, in square brackets ([ and ]). Configuration files may include comments, prefixed by # or ;. Comments may appear on their own on an otherwise empty line, possibly indented.


### Location

The `config.ini` configuration file should be put in the default config directory. This location is different on different operating systems. A custom configuration file can be provided with the `--config` argument.

* Linux: `$HOME/.config/medisch-contact-downloader/config.ini`, which respects the `XDG_CONFIG_HOME` environment variable.

* MacOS: `$HOME/Library/Application Support/medisch-contact-downloader/config.ini`

* Windows: `%APPDATA%\medisch-contact-downloader\config.ini`


### Precedence / Override order

Command line options override the values in a configuration file.

### Example `config.ini`

```
; This is a comment
# This is another comment
[settings]  ; a section marker is required in INI files
verbose = True
download_dir = /home/folkert/Downloads
username = <username>  ; username for authentication with https://www.medischcontact.nl/
password = <password>  ; password
smtp_host = smtp.example.com  ; host name or ip address of the SMTP server
smtp_port = 587  ; port of the SMTP server
smtp_username = user@example.com  ; accountname, username, or email address of your email account for authentication
smtp_password = <password>  ; password of your email account for authentication.
sender = user@example.com
recipient = info@example.com
```


## Download

When an issue is downloaded, it is copied to the default download directory. This location is different on different operating systems. A custom download directory can be provided with the `--download_dir` argument.

### Location
* macOS: `~/Library/Application Support/medisch-contact-downloader`

* Windows: `%APPDATA%\medisch-contact-downloader`

* Linux (and other Unices): `~/.local/share/medisch-contact-downloader`


## Email

You can send an automated email message with the downloaded Epub as an attachment, for example to [send it to your Kindle](https://www.amazon.com/gp/sendtokindle/email). To use this feature, the `--email` argument should be provided to the command line tool, along with the required arguments: `--smtp_host`, `--smtp_port`, `--smtp_username`, `--smtp_password`, `--sender`, and `--recipient`. This option presumes the `--download` argument.

Please note that if you use 2-step-verification in a Gmail-account, you might need an App Password (see https://support.google.com/accounts/answer/185833)


## Changelog

### [0.2.5] - 2023-03-25
- Fix changed datestring on website
- Show usage info when no arguments are given

### [0.2.4] - 2022-08-01
- Fix handling of subject and body arguments

### [0.2.3] - 2022-08-01
- Fix arguments
- Correct Windows default download directory in README

### [0.2.2] - 2022-08-01
- Implement CSRF protection of changed login page

### [0.2.1] - 2022-02-24
- Ensure unique filename by adding id

### [0.2] - 2022-02-23
-  Bugfixes

### [0.1.0] - 2022-02-21
-  First release on PyPI.


## Author
- Folkert van der Beek - https://gitlab.com/fvdbeek

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/fvdbeek/medisch-contact-downloader",
    "name": "medisch-contact-downloader",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "Medisch Contact,download,epub",
    "author": "Folkert van der Beek",
    "author_email": "folkertvanderbeek@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/79/83/565b0b2abc3d26ec49b8b0e496878bba405edfdeb68c3c97bd276f14c18b/medisch-contact-downloader-0.2.5.tar.gz",
    "platform": null,
    "description": "# Download Medisch Contact and convert to EPUB\n\n> A command line tool and lib to download Medisch Contact and convert to EPUB\n\n## Introduction\n\n[Medisch Contact](https://www.medischcontact.nl/) is a Dutch magazine for medical doctors.\n\nThis package provides a Python libary and command line tool for convenient downloading of the online contents to EPUB files.\n\n* Free software: MIT license\n\n\n## Installation\n\nIf you have Python on your system you can do the usual:\n\n    $ pip install medisch-contact-downloader\n\n\n## Quickstart\n\n### Command line usage examples\n\nList all issues in the current year. For listing only, no authentication is required.\n\n    $ medisch-contact-downloader -l\n\nList all issues in the years 2002, 2004, 2006, 2007, and 2008:\n\n    $ medisch-contact-downloader -l -y 2002 2004 2006-2008\n\nDownload the latest issue to the default download-directory. For downloading, a username and password is required for authentication.\n\n    $ medisch-contact-downloader -u username -p password -d\n\n\nDownload the issues with the IDs 2022-4 and 2022-5 to the ~/Downloads download-directory. An ID is composed of the year and number of the issue.\n\n    $ medisch-contact-downloader -u username -p password -d -i 2022-4 2022-5 -w ~/Downloads\n\nEmail the latest issue:\n\n    $ medisch-contact-downloader -e -u username -p password --smtp_host smtp.example.com --smtp_port 587 --smtp_username user@example.com --smtp_password <password> --sender user@example.com --recipient info@example.com\n\nShow command line help::\n\n    $ medisch-contact-downloader -h\n\n\n## Configuration File\n\nThe configuration file `config.ini` can change the default values for command line options. It should be written using a standard INI style. The keys should be grouped into sections. For now, the name of the sections are ignored. The section name appears on a line by itself, in square brackets ([ and ]). Configuration files may include comments, prefixed by # or ;. Comments may appear on their own on an otherwise empty line, possibly indented.\n\n\n### Location\n\nThe `config.ini` configuration file should be put in the default config directory. This location is different on different operating systems. A custom configuration file can be provided with the `--config` argument.\n\n* Linux: `$HOME/.config/medisch-contact-downloader/config.ini`, which respects the `XDG_CONFIG_HOME` environment variable.\n\n* MacOS: `$HOME/Library/Application Support/medisch-contact-downloader/config.ini`\n\n* Windows: `%APPDATA%\\medisch-contact-downloader\\config.ini`\n\n\n### Precedence / Override order\n\nCommand line options override the values in a configuration file.\n\n### Example `config.ini`\n\n```\n; This is a comment\n# This is another comment\n[settings]  ; a section marker is required in INI files\nverbose = True\ndownload_dir = /home/folkert/Downloads\nusername = <username>  ; username for authentication with https://www.medischcontact.nl/\npassword = <password>  ; password\nsmtp_host = smtp.example.com  ; host name or ip address of the SMTP server\nsmtp_port = 587  ; port of the SMTP server\nsmtp_username = user@example.com  ; accountname, username, or email address of your email account for authentication\nsmtp_password = <password>  ; password of your email account for authentication.\nsender = user@example.com\nrecipient = info@example.com\n```\n\n\n## Download\n\nWhen an issue is downloaded, it is copied to the default download directory. This location is different on different operating systems. A custom download directory can be provided with the `--download_dir` argument.\n\n### Location\n* macOS: `~/Library/Application Support/medisch-contact-downloader`\n\n* Windows: `%APPDATA%\\medisch-contact-downloader`\n\n* Linux (and other Unices): `~/.local/share/medisch-contact-downloader`\n\n\n## Email\n\nYou can send an automated email message with the downloaded Epub as an attachment, for example to [send it to your Kindle](https://www.amazon.com/gp/sendtokindle/email). To use this feature, the `--email` argument should be provided to the command line tool, along with the required arguments: `--smtp_host`, `--smtp_port`, `--smtp_username`, `--smtp_password`, `--sender`, and `--recipient`. This option presumes the `--download` argument.\n\nPlease note that if you use 2-step-verification in a Gmail-account, you might need an App Password (see https://support.google.com/accounts/answer/185833)\n\n\n## Changelog\n\n### [0.2.5] - 2023-03-25\n- Fix changed datestring on website\n- Show usage info when no arguments are given\n\n### [0.2.4] - 2022-08-01\n- Fix handling of subject and body arguments\n\n### [0.2.3] - 2022-08-01\n- Fix arguments\n- Correct Windows default download directory in README\n\n### [0.2.2] - 2022-08-01\n- Implement CSRF protection of changed login page\n\n### [0.2.1] - 2022-02-24\n- Ensure unique filename by adding id\n\n### [0.2] - 2022-02-23\n-  Bugfixes\n\n### [0.1.0] - 2022-02-21\n-  First release on PyPI.\n\n\n## Author\n- Folkert van der Beek - https://gitlab.com/fvdbeek\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Download Medisch Contact and convert to EPUB",
    "version": "0.2.5",
    "split_keywords": [
        "medisch contact",
        "download",
        "epub"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9843c2d8458b6909af54f5261054bee991108524a1128a67892ef04813503538",
                "md5": "012e6429a110f037d6eb0b9f48445d81",
                "sha256": "4308fe2082c0bb881f7b10837471cdd424fbf189ccae4decf8d78e4a8c1bd463"
            },
            "downloads": -1,
            "filename": "medisch_contact_downloader-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "012e6429a110f037d6eb0b9f48445d81",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12248,
            "upload_time": "2023-03-25T17:23:34",
            "upload_time_iso_8601": "2023-03-25T17:23:34.840872Z",
            "url": "https://files.pythonhosted.org/packages/98/43/c2d8458b6909af54f5261054bee991108524a1128a67892ef04813503538/medisch_contact_downloader-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7983565b0b2abc3d26ec49b8b0e496878bba405edfdeb68c3c97bd276f14c18b",
                "md5": "09901717c1d31993717d81c5ee6074dd",
                "sha256": "3f916e389dcc47805e91dfd75db26eb9213b331729a2f6ac4aa02a7e9125aae5"
            },
            "downloads": -1,
            "filename": "medisch-contact-downloader-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "09901717c1d31993717d81c5ee6074dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13499,
            "upload_time": "2023-03-25T17:23:36",
            "upload_time_iso_8601": "2023-03-25T17:23:36.927461Z",
            "url": "https://files.pythonhosted.org/packages/79/83/565b0b2abc3d26ec49b8b0e496878bba405edfdeb68c3c97bd276f14c18b/medisch-contact-downloader-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-25 17:23:36",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "gitlab_user": "fvdbeek",
    "gitlab_project": "medisch-contact-downloader",
    "lcname": "medisch-contact-downloader"
}
        
Elapsed time: 0.05876s