epr2md


Nameepr2md JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryConverts EPR files to Markdown
upload_time2024-12-17 21:36:50
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseGNU AFFERO GENERAL PUBLIC LICENSE
keywords epr issues python
VCS
bugtrack_url
requirements setuptools twine wheel build click html-testRunner buildlackey
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/hasii2011/epr2md/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/hasii2011/epr2md/tree/master)
[![PyPI version](https://badge.fury.io/py/epr2md.svg)](https://badge.fury.io/py/epr2md)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

# Introduction

A simple python console script to let me convert [epr](https://github.com/sshaw/export-pull-requests) files to [Markdown](https://www.howtogeek.com/448323/what-is-markdown-and-how-do-you-use-it/).

Typical export-pull-requests file that I generate use the following CLI invocation:

```
epr hasii2011/gittodoistclone --milestone=5 --export=issues --token=myToken --state=closed > release-0.98.0.csv 
```
The various columns are in this format:

```
Repository,Type,#,User,Title,State,Created,Updated,URL
```

A [CSV](https://file.org/extension/csv) line like this:

```
hasii2011/PyUt,Issue,359,hasii2011,Fix warning in PyutLink.setType,closed,03/23/22 09:50:04,03/23/22 13:56:09,https://github.com/hasii2011/PyUt/issues/359
```

Gets converted to a Markdown line like this:

```Markdown
* [359](https://github.com/hasii2011/PyUt/issues/359) Fix warning in PyutLink.setType
```
# Overview

The basic command structure is:

```
Usage: epr2md [OPTIONS]

Options:
  --version               Show the version and exit.
  -i, --input-file TEXT   The input .csv file to convert.  [required]
  -o, --output-file TEXT  The output .md file.
  --help                  Show this message and exit.
```

By default, epr2md assumes that the input file has a `.csv` suffix and the output file has a `.md` suffix. 

However, epr2md is flexible and can deduce file names and suffixes.  The best option is if you do not specify the output file.  Then epr2md deduces that the output file is the same as the input file name with the .md suffix.  For example:

```epr2md -i release-6.5.4.csv```

causes pyut2xml to write to a file named TestFileV10.xml

The command line:

```epr2md -i release-6.5.4 -o release-6.5.4```

reads from release-6.5.4.csv and writes to release-6.5.4.md


Another simple example:

```epr2md -i release-6.5.4```

causes pyut2xml to reads from a file named TestFileV10.csv and write to a file named release-6.5.4.md

# Installation

```pip install epr2md```


___

Written by Humberto A. Sanchez II <mailto@humberto.a.sanchez.ii@gmail.com>, (C) 2024

 

 
## Note
For all kind of problems, requests, enhancements, bug reports, etc.,
please drop me an e-mail.


------


![Humberto's Modified Logo](https://raw.githubusercontent.com/wiki/hasii2011/gittodoistclone/images/SillyGitHub.png)

I am concerned about GitHub's Copilot project


I urge you to read about the
[Give up GitHub](https://GiveUpGitHub.org) campaign from
[the Software Freedom Conservancy](https://sfconservancy.org).

While I do not advocate for all the issues listed there I do not like that
a company like Microsoft may profit from open source projects.

I continue to use GitHub because it offers the services I need for free.  But, I continue
to monitor their terms of service.

Any use of this project's code by GitHub Copilot, past or present, is done
without my permission.  I do not consent to GitHub's use of this project's
code in Copilot.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "epr2md",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "\"Humberto A. Sanchez II\" <Humbert.A.Sanchez.II@gmail.com>",
    "keywords": "epr, issues, python",
    "author": null,
    "author_email": "\"Humberto A. Sanchez II\" <Humbert.A.Sanchez.II@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b0/3f/95101b3194f730d382bb279eae33bc26d9973e0961e80ad7ca851e4b8bb8/epr2md-0.2.1.tar.gz",
    "platform": null,
    "description": "\n[![CircleCI](https://dl.circleci.com/status-badge/img/gh/hasii2011/epr2md/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/hasii2011/epr2md/tree/master)\n[![PyPI version](https://badge.fury.io/py/epr2md.svg)](https://badge.fury.io/py/epr2md)\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\n\n# Introduction\n\nA simple python console script to let me convert [epr](https://github.com/sshaw/export-pull-requests) files to [Markdown](https://www.howtogeek.com/448323/what-is-markdown-and-how-do-you-use-it/).\n\nTypical export-pull-requests file that I generate use the following CLI invocation:\n\n```\nepr hasii2011/gittodoistclone --milestone=5 --export=issues --token=myToken --state=closed > release-0.98.0.csv \n```\nThe various columns are in this format:\n\n```\nRepository,Type,#,User,Title,State,Created,Updated,URL\n```\n\nA [CSV](https://file.org/extension/csv) line like this:\n\n```\nhasii2011/PyUt,Issue,359,hasii2011,Fix warning in PyutLink.setType,closed,03/23/22 09:50:04,03/23/22 13:56:09,https://github.com/hasii2011/PyUt/issues/359\n```\n\nGets converted to a Markdown line like this:\n\n```Markdown\n* [359](https://github.com/hasii2011/PyUt/issues/359) Fix warning in PyutLink.setType\n```\n# Overview\n\nThe basic command structure is:\n\n```\nUsage: epr2md [OPTIONS]\n\nOptions:\n  --version               Show the version and exit.\n  -i, --input-file TEXT   The input .csv file to convert.  [required]\n  -o, --output-file TEXT  The output .md file.\n  --help                  Show this message and exit.\n```\n\nBy default, epr2md assumes that the input file has a `.csv` suffix and the output file has a `.md` suffix. \n\nHowever, epr2md is flexible and can deduce file names and suffixes.  The best option is if you do not specify the output file.  Then epr2md deduces that the output file is the same as the input file name with the .md suffix.  For example:\n\n```epr2md -i release-6.5.4.csv```\n\ncauses pyut2xml to write to a file named TestFileV10.xml\n\nThe command line:\n\n```epr2md -i release-6.5.4 -o release-6.5.4```\n\nreads from release-6.5.4.csv and writes to release-6.5.4.md\n\n\nAnother simple example:\n\n```epr2md -i release-6.5.4```\n\ncauses pyut2xml to reads from a file named TestFileV10.csv and write to a file named release-6.5.4.md\n\n# Installation\n\n```pip install epr2md```\n\n\n___\n\nWritten by Humberto A. Sanchez II <mailto@humberto.a.sanchez.ii@gmail.com>, (C) 2024\n\n \n\n \n## Note\nFor all kind of problems, requests, enhancements, bug reports, etc.,\nplease drop me an e-mail.\n\n\n------\n\n\n![Humberto's Modified Logo](https://raw.githubusercontent.com/wiki/hasii2011/gittodoistclone/images/SillyGitHub.png)\n\nI am concerned about GitHub's Copilot project\n\n\nI urge you to read about the\n[Give up GitHub](https://GiveUpGitHub.org) campaign from\n[the Software Freedom Conservancy](https://sfconservancy.org).\n\nWhile I do not advocate for all the issues listed there I do not like that\na company like Microsoft may profit from open source projects.\n\nI continue to use GitHub because it offers the services I need for free.  But, I continue\nto monitor their terms of service.\n\nAny use of this project's code by GitHub Copilot, past or present, is done\nwithout my permission.  I do not consent to GitHub's use of this project's\ncode in Copilot.\n",
    "bugtrack_url": null,
    "license": "GNU AFFERO GENERAL PUBLIC LICENSE",
    "summary": "Converts EPR files to Markdown",
    "version": "0.2.1",
    "project_urls": {
        "Repository": "https://github.com/hasii2011/epr2md"
    },
    "split_keywords": [
        "epr",
        " issues",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3e70096fe3f5ef6ee92fd2677afa434acdc5b3bca7edee734cdea53367434df",
                "md5": "23f2e5751f3d49404c02e977a7c613ab",
                "sha256": "8f06ec9cb29c0ad224043248af7ae6dc6a26535854ae2b7f29cd30106be0d226"
            },
            "downloads": -1,
            "filename": "epr2md-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "23f2e5751f3d49404c02e977a7c613ab",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17136,
            "upload_time": "2024-12-17T21:36:49",
            "upload_time_iso_8601": "2024-12-17T21:36:49.195716Z",
            "url": "https://files.pythonhosted.org/packages/d3/e7/0096fe3f5ef6ee92fd2677afa434acdc5b3bca7edee734cdea53367434df/epr2md-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b03f95101b3194f730d382bb279eae33bc26d9973e0961e80ad7ca851e4b8bb8",
                "md5": "52916e808d6b3e0c61127ca69102624b",
                "sha256": "5e559563031a2402e30351b118b2fcdc71fcf02839ac84fdf94a0886d56f0b63"
            },
            "downloads": -1,
            "filename": "epr2md-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "52916e808d6b3e0c61127ca69102624b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16502,
            "upload_time": "2024-12-17T21:36:50",
            "upload_time_iso_8601": "2024-12-17T21:36:50.564244Z",
            "url": "https://files.pythonhosted.org/packages/b0/3f/95101b3194f730d382bb279eae33bc26d9973e0961e80ad7ca851e4b8bb8/epr2md-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-17 21:36:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hasii2011",
    "github_project": "epr2md",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "requirements": [
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "75.6.0"
                ]
            ]
        },
        {
            "name": "twine",
            "specs": [
                [
                    "==",
                    "6.0.1"
                ]
            ]
        },
        {
            "name": "wheel",
            "specs": [
                [
                    "==",
                    "0.45.1"
                ]
            ]
        },
        {
            "name": "build",
            "specs": [
                [
                    "==",
                    "1.2.2.post1"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    "==",
                    "8.1.7"
                ]
            ]
        },
        {
            "name": "html-testRunner",
            "specs": [
                [
                    "==",
                    "1.2.1"
                ]
            ]
        },
        {
            "name": "buildlackey",
            "specs": [
                [
                    "==",
                    "1.7.0"
                ]
            ]
        }
    ],
    "lcname": "epr2md"
}
        
Elapsed time: 0.37481s