https://github.com/bbugyi200/magodo

A Python library for working with the todo.txt format, with some magic thrown in.
https://github.com/bbugyi200/magodo

cc-python library parser productivity python todo todotxt

Last synced: about 1 month ago
JSON representation

A Python library for working with the todo.txt format, with some magic thrown in.

• Host: GitHub
• URL: https://github.com/bbugyi200/magodo
• Owner: bbugyi200
• Created: 2022-01-12T14:37:16.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-23T19:15:22.000Z (over 2 years ago)
• Last Synced: 2024-12-06T15:51:39.147Z (2 months ago)
• Topics: cc-python, library, parser, productivity, python, todo, todotxt
• Language: Python
• Homepage: https://magodo.readthedocs.io/en/latest
• Size: 247 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# magodo

**A Python library for working with the todo.txt format, with some magic thrown in.**

_project status badges:_

[![CI Workflow](https://github.com/bbugyi200/magodo/actions/workflows/ci.yml/badge.svg)](https://github.com/bbugyi200/magodo/actions/workflows/ci.yml)

[![Coverage](https://codecov.io/gh/bbugyi200/magodo/branch/master/graph/badge.svg)](https://codecov.io/gh/bbugyi200/magodo)

[![Documentation Status](https://readthedocs.org/projects/magodo/badge/?version=latest)](https://magodo.readthedocs.io/en/latest/?badge=latest)

[![Package Health](https://snyk.io/advisor/python/magodo/badge.svg)](https://snyk.io/advisor/python/magodo)

_version badges:_

[![Project Version](https://img.shields.io/pypi/v/magodo)](https://pypi.org/project/magodo/)

[![Python Versions](https://img.shields.io/pypi/pyversions/magodo)](https://pypi.org/project/magodo/)

[![Cookiecutter: cc-python](https://img.shields.io/static/v1?label=cc-python&message=2022.01.04&color=d4aa00&logo=cookiecutter&logoColor=d4aa00)](https://github.com/python-boltons/cc-python)

[![Docker: pythonboltons/main](https://img.shields.io/static/v1?label=pythonboltons%20%2F%20main&message=2021.12.22&color=8ec4ad&logo=docker&logoColor=8ec4ad)](https://github.com/python-boltons/docker-python)

## Installation 🗹

To install `magodo` using [pip][9], run the following

commands in your terminal:

``` shell

python3 -m pip install --user magodo  # install magodo

```

If you don't have pip installed, this [Python installation guide][10] can guide

you through the process.

## Useful Links 🔗

* [API Reference][3]: A developer's reference of the API exposed by this

  project.

* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.

  Changes made to this cookiecutter are periodically synced with this project

  using [cruft][12].

* [CHANGELOG.md][2]: We use this file to document all notable changes made to

  this project.

* [CONTRIBUTING.md][7]: This document contains guidelines for developers

  interested in contributing to this project.

* [Create a New Issue][13]: Create a new GitHub issue for this project.

* [Documentation][1]: This project's full documentation.

[1]: https://magodo.readthedocs.io/en/latest

[2]: https://github.com/bbugyi200/magodo/blob/master/CHANGELOG.md

[3]: https://magodo.readthedocs.io/en/latest/modules.html

[4]: https://github.com/python-boltons/cc-python

[5]: https://github.com/cookiecutter/cookiecutter

[6]: https://docs.readthedocs.io/en/stable/

[7]: https://github.com/bbugyi200/magodo/blob/master/CONTRIBUTING.md

[8]: https://github.com/bbugyi200/magodo

[9]: https://pip.pypa.io

[10]: http://docs.python-guide.org/en/latest/starting/installation/

[11]: https://github.com/pypa/pipx

[12]: https://github.com/cruft/cruft

[13]: https://github.com/bbugyi200/magodo/issues/new/choose