Metadata-Version: 2.1
Name: pycoffee
Version: 1.0.4
Summary: Programmers' tools. Enjoy Coffee time!
Author: tkorays
Author-email: tkorays <tkorays@hotmail.com>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/tkorays/pycoffee
Project-URL: Bug Tracker, https://github.com/tkorays/pycoffee/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

<p align="center">
  <h2 align="center">☕ pycoffee</h2>
</p>

<p align="center">
  Assign your work to the machine and enjoy coffee!
</p>
<p align="center">
	<a href="https://github.com/tkorays/pycoffee/stargazers">
		<img alt="Stars" src="https://img.shields.io/github/stars/tkorays/pycoffee?style=for-the-badge&logo=starship&color=F3B562&logoColor=D9E0EE&labelColor=302D41"></a>
	<a href="https://github.com/tkorays/pycoffee/issues">
		<img alt="Issues" src="https://img.shields.io/github/issues/tkorays/pycoffee?style=for-the-badge&logo=bilibili&color=F06060&logoColor=D9E0EE&labelColor=302D41"></a>
	<a href="https://github.com/tkorays/pycoffee">
		<img alt="Size" src="https://img.shields.io/github/repo-size/tkorays/pycoffee?color=8CBEB2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41"/></a>
</p>
&nbsp;


**Table of contents**
- [description](#description)
- [Getting started](#getting-started)
- [Extend your playbooks](#Extend-your-playbooks)
- [Author](#author)
- [Contributing](#contributing)

## description
`pycoffee` is a toolbox for improving the efficiency in daily work.
Our goal is saving your time and offer you more time to enjoy coffee! 

We provide some features you may like:

* Data extracting, processing and visualizing
  * Extract data from log file, see `Coffee.Data.DataLoader`
  * Store data to timeseries database, see `Coffee.Data.Database`
  * Generate Grafana dashboard by code, see `Coffee.Data.DataViz`
* All workflows are provided with the playbooks, see the default playbook `Coffee.Playbook.PowerToys`
* Plugin based architecture, you can extend the coffee by writing your playbooks

## Getting started

you can install the stable version pycoffee by pip:

```bash
# use pip to install the latest version
pip install pycoffee
```

or you can download the code and run `python ./setup.py install` in the project root.

Just run `--help` to see what features pycoffee provided. 

```bash
# use `--help` to see tools
cof --help

# show external playbooks
cof play --help
```

## Extend your playbooks
Custom playbooks are located in `~/.coffee/CustomPlays/`.
You should create a new directory to hold the playbook's source code and the directory name is the playbook's package name.
An example can be found in `Coffee.Playbook.PowerToys`.

For Example, code in `~/.coffee/CustomPlays/HelloWorld/__init__.py`:

```python
import click


@click.command("hello", help="print hello world")
def play_hello():
  click.echo('hello world')

# commands should be placed in the package's `__init__.py` file
commands = [play_hello, ]
```

Then type `cof play hello` in your console, and you will see the printed `hello world`.

## Author
tkorays <tkorays@hotmail.com>


## Contributing
Welcome to contribute code!
