Merge pull request #7 from lcfd/0.0.1

0.0.2

README.md

@@ -1,21 +1,102 @@
 <p align="center">
   <a href="https://github.com/lcfd/trak">
-    <img src="./assets/banner.png" alt="Trak">
+    <img src="./assets/banner.png" alt="Trak banner">
   </a>
 
   <h1 align="center">trak</h1>
 
   <p align="center">
-    Project time tracking CLI
-    <br />
     <br />
     Trak is a CLI to track the time you spend on projects, with useful reports and analytics.
     <br />
+    <br />
     For freelancers, by a freelance.
     <br />
     <br />
     <a href="https://usetrak.com">Website</a>
     ·
     <a href="https://github.com/lcfd/trak/issues">Issues</a>
+    ·
+    <a href="https://usetrak.com/docs/">Documentation</a>
+    •
+    <a href="https://github.com/lcfd/trak/discussions">Feedback</a>
   </p>
-</p>
+</p>
+
+## Installation
+
+### Pypi
+
+[On Pypi](https://pypi.org/project/trakcli/) you can find the package under the `trakcli` name.
+
+You can install it with pip:
+
+```bash
+pip install trakcli
+```
+
+or with pipx:
+
+```bash
+pipx install trakcli
+```
+### Brew
+
+TBA
+### Local
+
+Run `poetry build` and then
+
+```bash
+# x.x.x = The version you have used to do the build.
+pipx install ./dist/trakcli-x.x.x-py3-none-any.whl
+```
+
+to install `trak` usign the wheel file.
+
+
+## Usage
+
+The package has the useful `--help` command that will explain all the commands.
+
+The CLI will guide you anyway through what you should and must do with messages with specific messages.
+
+### Basic commands
+
+```bash
+trak start <project-name>
+
+trak stop
+
+trak status
+
+trak report <project-name>
+```
+
+Start trakking a project that is billable:
+
+`trak start pasta -b`
+
+Start tracking a project on a specific category/topic:
+
+`trak start pasta -c rigatoni`
+
+All the commands are described in the help command:
+
+`trak --help`
+
+## Starship
+
+There is a dedicated command that ouputs clean strings for tools like Starship:
+
+`trak status -s` or `trak status --starship`
+
+To see the status in your terminal line open `$HOME/.config/starship.toml`
+and put this snippet inside of it:
+
+```bash
+[custom.trak]
+command = """ trak status -s """
+when = "trak status"
+shell = "sh"
+```

cli/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

cli/README.md

@@ -0,0 +1,17 @@
+![alt](https://raw.githubusercontent.com/lcfd/trak/main/assets/banner.png)
+
+# trak
+
+trak is a **CLI** to **track** the **time** you spend on **projects**, with useful reports and analytics.
+
+For freelancers, by a freelance.
+
+## Links
+
+[Website](https://usetrak.com)
+•
+[Issues](https://github.com/lcfd/trak/issues)
+•
+[Documentation](https://usetrak.com/docs/)
+•
+[Feedback](https://github.com/lcfd/trak/discussions)