Data Watch ORM

An easy to step up Python ORM that can be integrated in any Python project

Table of Contents

• About the project
• Documentation
• Contributing
• More ways to contribute
• License
• Contact

About the project

DataWatchORM is a lightweight, flexible Object-Relational Mapping (ORM) library designed to simplify database interactions in Python. Inspired by Django's ORM, DataWatchORM provides intuitive APIs for defining schemas, querying data, and managing relationships between models, all while offering the flexibility to extend and modify query behavior. DataWatchORM makes it easy to build and maintain database-driven applications with clean, readable code.

Documentation

Read the full documentation. here.

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 this repository.

2. Clone the repository to your own machine by running one of the following commands:

   • HTTPS

   git clone https://github.com/<your-username>/data-watch-orm.git
   

   OR

   • SSH

   git clone git@github.com:<your-username>/data-watch-orm.git
   

   OR

   • Github CLI:

   gh repo clone <your-username>/data-watch-orm
   

3. Create a new branch. The name of the branch must reflect the change you are about to make.

   git checkout -b <branch-name>
   

4. Make your changes or add your new feature. Remember to commit early and commit often. Read our commit rules here.

   • Short commit messages:

     git add <changed-files>
     git commit -m "<commit-message>"
     

   • Long commit messages:

     git add <changed-files>
     git commit
     

5. Push your changes to Github by running this command:

   git push origin <branch-name>
   

6. Go over to GitHub and create a pull request. Make sure to include a comment explaining the additions. Please include the issue number being addressed in your comment. For instance, if you were resolving issue 6, add Issue: #6 at the end of your comment. For more information, please refer to our contributing rules here.

More ways to contribute

You can contribute not only by writing code but also by assisting us in enhancing this README, drafting documentation, creating tutorials, and more.

• Enhance this README.
• Draft the documentation.
• Create a tutorial on our website.
• Produce video tutorials.
• Write tests.
• Design a logo for us.
• Report bugs.
• Suggest any additional elements you believe should be included.

License

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

Contact

Lindelwa - nqabenhlemlaba22@gmail.com

Instagram - https://www.instagram.com/asanda.que

GitHub - https://github.com/lindelwa122