README
¶
Core Library (Database())
One Paragraph of the project description
Initially appeared on gist. But the page cannot open anymore so that is why I have moved it here.
Getting Started
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
Prerequisites
Requirements for the software and other tools to build, test and push
Installing
A step by step series of examples that tell you how to get a development environment running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Running the tests
Explain how to run the automated tests for this system
Sample Tests
Explain what these tests test and why
Give an example
Style test
Checks if the best practices and the right coding style has been used.
Give an example
Deployment
Add additional notes to deploy this on a live system
Built With
- Contributor Covenant - Used for the Code of Conduct
- Creative Commons - Used to choose the license
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
Authors
- Billie Thompson - Provided README Template - PurpleBooth
See also the list of contributors who participated in this project.
License
This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details
Acknowledgments
- Hat tip to anyone whose code is used
- Inspiration
- etc
Documentation
¶
Overview ¶
Package database provides global access to database operations exposed by the core library. The subpackages of the database package provide varios data storage implementations.
The provided API is used to initialize and interact with a datastore of choice
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package database witholds database specific utilities for the core database libary This package mainly deals with interactions with the postgresql database.
|
Package database witholds database specific utilities for the core database libary This package mainly deals with interactions with the postgresql database. |
|
Package rediswrapper provides a simple Redis client wrapper to easily interface with Redis server for caching and storage purposes.
|
Package rediswrapper provides a simple Redis client wrapper to easily interface with Redis server for caching and storage purposes. |