Skip to content

Latest commit

 

History

History
141 lines (107 loc) · 5.88 KB

README.md

File metadata and controls

141 lines (107 loc) · 5.88 KB


Logo

duckron

manage your local storage · · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Originally created to streamline the management of local DuckDB databases, this project offers a powerful, easy-to-use toolset for handling database backups, setting retention policies, and monitoring database health metrics, such as file size and integrity. What started as a focused utility for DuckDB quickly expanded to support broader database management needs on local systems.

With an emphasis on automation and simplicity, this tool is ideal for developers and data engineers seeking reliable, hassle-free local database maintenance. By centralizing core management functions, it reduces manual overhead, enhances database reliability, and ensures data safety with minimal configuration.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

  • Write retention policy manager
  • Write health manager
  • Implement webhooks

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Berkant Ay - @berkantay2

Project Link: https://github.com/berkantay/duckron