https://github.com/nstrydom2/microblog
A lightweight blog for the command-line
https://github.com/nstrydom2/microblog
blog cli command-line python sqlite3
Last synced: 3 months ago
JSON representation
A lightweight blog for the command-line
- Host: GitHub
- URL: https://github.com/nstrydom2/microblog
- Owner: nstrydom2
- License: mit
- Created: 2019-08-21T00:39:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-17T02:52:35.000Z (about 5 years ago)
- Last Synced: 2024-05-02T04:06:48.863Z (about 2 years ago)
- Topics: blog, cli, command-line, python, sqlite3
- Language: Python
- Homepage:
- Size: 3.65 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# microblog
A lightweight blog for the command-line that utilizes an SQLite3 database for performance and simplicity.
## Getting Started
These instructions will get you a copy of the project up and running on your local
machine for development and testing purposes. See deployment for notes on how to
deploy the project on a live system.
### Prerequisites
Python 3.7+ is required to run this application, other than that there are no
prerequisites for the project, as the dependencies are included in the repository.
### Installing
To install the library is as simple as cloning the repository and running
```bash
pip install -e .
```
It is recommended to create an virtual environment prior to installing this library.
Alternatively, you can also install this library via Pip:
```bash
pip install microblog
```
And start blogging from any terminal you want!
### Dev Notes
Run unit tests locally:
```bash
pytest --verbosity=2
```
Add the `-k test_*` option if you want to test only a single function.
## Usage
```python
```
## Command Line Interface
```bash
```
## Built With
*
## Versioning
Navigate to [tags on this repository](https://github.com/nstrydom2/microblog/tags)
to see all available versions.
## Authors
| Name | Mail Address | GitHub Profile |
|------------------|-----------------------------|-----------------------------------------------|
| Nicholas Strydom | nstrydom@gmail.com | [nstrydom2](https://github.com/nstrydom2) |
See also the list of [contributors](https://github.com/nstrydom2/microblog/contributors)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details.
## Acknowledgments
* Joseph Marie Jacquard
* Charles Babbage
* Ada Lovelace
* My Dad
* Hat tip to anyone whose code was used
* Inspiration
* etc