41 lines
1,006 B
Markdown
41 lines
1,006 B
Markdown
# cry
|
|
|
|
[](https://pypi.org/project/cry/)
|
|
[](https://github.com/decarabas/cry/releases)
|
|
[](https://github.com/decarabas/cry/actions/workflows/test.yml)
|
|
[](https://github.com/decarabas/cry/blob/master/LICENSE)
|
|
|
|
Command line feed reader
|
|
|
|
## Installation
|
|
|
|
Install this tool using `pip`:
|
|
```bash
|
|
pip install cry
|
|
```
|
|
## Usage
|
|
|
|
For help, run:
|
|
```bash
|
|
cry --help
|
|
```
|
|
You can also use:
|
|
```bash
|
|
python -m cry --help
|
|
```
|
|
## Development
|
|
|
|
To contribute to this tool, first checkout the code. Then create a new virtual environment:
|
|
```bash
|
|
cd cry
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
```
|
|
Now install the dependencies and test dependencies:
|
|
```bash
|
|
pip install -e '.[test]'
|
|
```
|
|
To run the tests:
|
|
```bash
|
|
pytest
|
|
```
|