An open API service indexing awesome lists of open source software.

https://github.com/epocdotfr/pyopml

Python package meant to read, manipulate and write OPML 2.0 files
https://github.com/epocdotfr/pyopml

opml opml-files pypi pypi-packages python python-library

Last synced: 10 months ago
JSON representation

Python package meant to read, manipulate and write OPML 2.0 files

Awesome Lists containing this project

README

          

# PyOPML

Python package meant to read, manipulate and write [OPML 2.0](http://opml.org/spec2.opml) files.

![Python versions](https://img.shields.io/pypi/pyversions/pyopml.svg) ![Version](https://img.shields.io/pypi/v/pyopml.svg) ![Tests](https://github.com/EpocDotFr/pyopml/actions/workflows/tests.yml/badge.svg) ![License](https://img.shields.io/pypi/l/pyopml.svg)

## Documentation

Everything you need to know is located [here](https://epocdotfr.github.io/pyopml/).

## Changelog

See [here](https://github.com/EpocDotFr/pyopml/releases).

## Development

**Getting source code, installing the package as well as its dev packages:**

1. Clone the repository
2. From the root directory, run: `pip install -e .[dev]` on Linux or `pip install -e ".[dev]"` on Windows

**Running tests:**

From the root directory, run `pytest`. They will automatically be all discovered and ran.

**Building docs:**

From the `docs` directory, run `make.bat html` on Windows or `make html` on Linux.

**Publishing the package:**

From the root directory, run `python setup.py upload`. This will create a git tag and publish on PyPI.