Skip to main content

Converts EPR files to Markdown

Project description

CircleCI PyPI version Maintenance forthebadge made-with-python

Introduction

A simple python console script to let me convert epr files to Markdown.

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 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:

* [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

I am concerned about GitHub's Copilot project

I urge you to read about the Give up GitHub campaign from the Software Freedom Conservancy.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epr2md-0.2.1.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

epr2md-0.2.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file epr2md-0.2.1.tar.gz.

File metadata

  • Download URL: epr2md-0.2.1.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for epr2md-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5e559563031a2402e30351b118b2fcdc71fcf02839ac84fdf94a0886d56f0b63
MD5 52916e808d6b3e0c61127ca69102624b
BLAKE2b-256 b03f95101b3194f730d382bb279eae33bc26d9973e0961e80ad7ca851e4b8bb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for epr2md-0.2.1.tar.gz:

Publisher: python-publish.yml on hasii2011/epr2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file epr2md-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: epr2md-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for epr2md-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8f06ec9cb29c0ad224043248af7ae6dc6a26535854ae2b7f29cd30106be0d226
MD5 23f2e5751f3d49404c02e977a7c613ab
BLAKE2b-256 d3e70096fe3f5ef6ee92fd2677afa434acdc5b3bca7edee734cdea53367434df

See more details on using hashes here.

Provenance

The following attestation bundles were made for epr2md-0.2.1-py3-none-any.whl:

Publisher: python-publish.yml on hasii2011/epr2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page