Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/withprecedent/nagata

Easy, extensible, accessible file management for Python projects
https://github.com/withprecedent/nagata

file-management loading python saving serialization

Last synced: about 2 months ago
JSON representation

Easy, extensible, accessible file management for Python projects

Awesome Lists containing this project

README

        

# nagata

| | |
| --- | --- |
| Version | [![PyPI Latest Release](https://img.shields.io/pypi/v/nagata.svg?style=for-the-badge&color=steelblue&label=PyPI&logo=PyPI&logoColor=yellow)](https://pypi.org/project/nagata/) [![GitHub Latest Release](https://img.shields.io/github/v/tag/WithPrecedent/nagata?style=for-the-badge&color=navy&label=GitHub&logo=github)](https://github.com/WithPrecedent/nagata/releases)
| Status | [![Build Status](https://img.shields.io/github/actions/workflow/status/WithPrecedent/nagata/ci.yml?branch=main&style=for-the-badge&color=cadetblue&label=Tests&logo=pytest)](https://github.com/WithPrecedent/nagata/actions/workflows/ci.yml?query=branch%3Amain) [![Development Status](https://img.shields.io/badge/Development-Active-seagreen?style=for-the-badge&logo=git)](https://www.repostatus.org/#active) [![Project Stability](https://img.shields.io/pypi/status/nagata?style=for-the-badge&logo=pypi&label=Stability&logoColor=yellow)](https://pypi.org/project/nagata/)
| Documentation | [![Hosted By](https://img.shields.io/badge/Hosted_by-Github_Pages-blue?style=for-the-badge&color=navy&logo=github)](https://WithPrecedent.github.io/nagata)
| Tools | [![Documentation](https://img.shields.io/badge/MkDocs-magenta?style=for-the-badge&color=deepskyblue&logo=markdown&labelColor=gray)](https://squidfunk.github.io/mkdocs-material/) [![Linter](https://img.shields.io/endpoint?style=for-the-badge&url=https://raw.githubusercontent.com/charliermarsh/Ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/Ruff) [![Dependency Manager](https://img.shields.io/badge/PDM-mediumpurple?style=for-the-badge&logo=affinity&labelColor=gray)](https://PDM.fming.dev) [![Pre-commit](https://img.shields.io/badge/pre--commit-darkolivegreen?style=for-the-badge&logo=pre-commit&logoColor=white&labelColor=gray)](https://github.com/TezRomacH/python-package-template/blob/master/.pre-commit-config.yaml) [![CI](https://img.shields.io/badge/GitHub_Actions-navy?style=for-the-badge&logo=githubactions&labelColor=gray&logoColor=white)](https://github.com/features/actions) [![Editor Settings](https://img.shields.io/badge/Editor_Config-paleturquoise?style=for-the-badge&logo=editorconfig&labelColor=gray)](https://editorconfig.org/) [![Repository Template](https://img.shields.io/badge/snickerdoodle-bisque?style=for-the-badge&logo=cookiecutter&labelColor=gray)](https://www.github.com/WithPrecedent/nagata) [![Dependency Maintainer](https://img.shields.io/badge/dependabot-navy?style=for-the-badge&logo=dependabot&logoColor=white&labelColor=gray)](https://github.com/dependabot)
| Compatibility | [![Compatible Python Versions](https://img.shields.io/pypi/pyversions/nagata?style=for-the-badge&color=steelblue&label=Python&logo=python&logoColor=yellow)](https://pypi.python.org/pypi/nagata/) [![Linux](https://img.shields.io/badge/Linux-lightseagreen?style=for-the-badge&logo=linux&labelColor=gray&logoColor=white)](https://www.linux.org/) [![MacOS](https://img.shields.io/badge/MacOS-snow?style=for-the-badge&logo=apple&labelColor=gray)](https://www.apple.com/macos/) [![Windows](https://img.shields.io/badge/windows-blue?style=for-the-badge&logo=Windows&labelColor=gray&color=orangered)](https://www.microsoft.com/en-us/windows?r=1)
| Stats | [![PyPI Download Rate (per month)](https://img.shields.io/pypi/dm/nagata?style=for-the-badge&color=steelblue&label=Downloads%20πŸ’Ύ&logo=pypi&logoColor=yellow)](https://pypi.org/project/nagata) [![GitHub Stars](https://img.shields.io/github/stars/WithPrecedent/nagata?style=for-the-badge&color=navy&label=Stars%20⭐&logo=github)](https://github.com/WithPrecedent/nagata/stargazers) [![GitHub Contributors](https://img.shields.io/github/contributors/WithPrecedent/nagata?style=for-the-badge&color=navy&label=Contributors%20πŸ™‹&logo=github)](https://github.com/WithPrecedent/nagata/graphs/contributors) [![GitHub Issues](https://img.shields.io/github/issues/WithPrecedent/nagata?style=for-the-badge&color=navy&label=Issues%20πŸ“˜&logo=github)](https://github.com/WithPrecedent/nagata/graphs/contributors) [![GitHub Forks](https://img.shields.io/github/forks/WithPrecedent/nagata?style=for-the-badge&color=navy&label=Forks%20🍴&logo=github)](https://github.com/WithPrecedent/nagata/forks)
| | |

-----

## What is nagata?

*This package is under heavy construction. Use at your own risk*


I came to help you.

*"Don’t decide for them. Tell them the truth and let them decide for themselves."* - Naomi Nagata

## Why use nagata?


Every shitty thing we do makes the next one that much easier, doesn't it?

[TODO: Features and reasons to use the project (and, possibly, not to use it)]

## Getting started

### Requirements

[TODO: List any OS or other restrictions and pre-installation dependencies]

### Installation

To install `nagata`, use `pip`:

```sh
pip install nagata
```

### Usage

[TODO: Describe common use cases, with possible example(s)]


There are other ways.

## Contributing

Contributors are always welcome. Feel free to grab an [issue](https://www.github.com/WithPrecedent/nagata/issues) to work on or make a suggested improvement. If you wish to contribute, please read the [Contribution Guide](https://www.github.com/WithPrecedent/nagata/contributing.md) and [Code of Conduct](https://www.github.com/WithPrecedent/nagata/code_of_conduct.md).

## Similar Projects

[TODO: If they exist, it is always nice to acknowledge other similar efforts]

## Acknowledgments

[TODO: Mention any people or organizations that warrant a special acknowledgment]

## License

Use of this repository is authorized under the [Apache Software License 2.0](https://www.github.com/WithPrecedent/nagata/blog/main/LICENSE).