Skip to content

Commit 9eea7fa

Browse files
committed
Initial open source release: core CLI, packaging, tests, CI/CD, and docs
0 parents  commit 9eea7fa

File tree

12 files changed

+1364
-0
lines changed

12 files changed

+1364
-0
lines changed

.coveragerc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[run]
2+
source = .
3+
omit =
4+
*/tests/*
5+
*/test_*.py
6+
*/__pycache__/*
7+
*/site-packages/*
8+
9+
[report]
10+
exclude_lines =
11+
pragma: no cover
12+
def __repr__
13+
raise NotImplementedError
14+
if __name__ == .__main__.:
15+
pass
16+
raise ImportError

.github/workflows/ci.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# GitHub Actions CI workflow for TaskNow CLI
2+
# This workflow runs tests, checks coverage, and builds the package on every push and pull request.
3+
# Compatible with Python 3.7+
4+
5+
name: CI for TaskNow CLI
6+
7+
on:
8+
push:
9+
branches: ["**"] # Run on all branches
10+
pull_request:
11+
branches: ["**"] # Run on all PRs
12+
13+
jobs:
14+
build-test:
15+
name: Test and Build on Python ${{ matrix.python-version }}
16+
runs-on: ubuntu-latest
17+
18+
strategy:
19+
matrix:
20+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
21+
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Python ${{ matrix.python-version }}
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: ${{ matrix.python-version }}
30+
31+
- name: Upgrade pip
32+
run: python -m pip install --upgrade pip
33+
34+
- name: Install dependencies
35+
run: |
36+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
37+
pip install pytest coverage
38+
39+
- name: Run tests with coverage
40+
run: |
41+
coverage run -m pytest
42+
coverage report
43+
coverage html # Generate HTML report
44+
45+
- name: Upload coverage report artifact
46+
uses: actions/upload-artifact@v4
47+
with:
48+
name: htmlcov-${{ matrix.python-version }}
49+
path: htmlcov # Directory generated by 'coverage html'
50+
51+
- name: Build package
52+
run: python setup.py sdist bdist_wheel
53+
54+
# Placeholder for future PyPI deployment
55+
# - name: Publish to PyPI
56+
# run: |
57+
# python -m pip install --upgrade twine
58+
# twine upload dist/*
59+
# env:
60+
# TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
61+
# TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

.gitignore

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
110+
# pdm
111+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
112+
#pdm.lock
113+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
114+
# in version control.
115+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
116+
.pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
121+
__pypackages__/
122+
123+
# Celery stuff
124+
celerybeat-schedule
125+
celerybeat.pid
126+
127+
# SageMath parsed files
128+
*.sage.py
129+
130+
# Environments
131+
.env
132+
.venv
133+
env/
134+
venv/
135+
ENV/
136+
env.bak/
137+
venv.bak/
138+
139+
# Spyder project settings
140+
.spyderproject
141+
.spyproject
142+
143+
# Rope project settings
144+
.ropeproject
145+
146+
# mkdocs documentation
147+
/site
148+
149+
# mypy
150+
.mypy_cache/
151+
.dmypy.json
152+
dmypy.json
153+
154+
# Pyre type checker
155+
.pyre/
156+
157+
# pytype static type analyzer
158+
.pytype/
159+
160+
# Cython debug symbols
161+
cython_debug/
162+
163+
# PyCharm
164+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
165+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
166+
# and can be added to the global gitignore or merged into this file. For a more nuclear
167+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
168+
#.idea/
169+
170+
# Ruff stuff:
171+
.ruff_cache/
172+
173+
# PyPI configuration file
174+
.pypirc
175+
176+
# Roomode
177+
.roomodes
178+
179+
# Memory Bank
180+
memory-bank/
181+
182+
# VS Code
183+
.vscode/

README.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# TaskNow
2+
3+
A minimalist terminal task manager that helps you focus on one task at a time, while still providing full task management capabilities.
4+
5+
## Features
6+
7+
- Single-task focus by default
8+
- Simple command-based interface
9+
- Full task list visibility when needed
10+
- Completion tracking
11+
- JSON-based data storage
12+
- Linux/Ubuntu compatible
13+
14+
## Installation
15+
16+
### Using pip and setup.py
17+
18+
1. Clone or download this repository.
19+
2. Navigate to the project directory.
20+
3. Run:
21+
22+
```bash
23+
pip install .
24+
```
25+
26+
This will install TaskNow and make the `tasknow` command available globally.
27+
28+
### Requirements
29+
30+
- Python 3.7 or higher
31+
- `setuptools` (installed automatically with pip)
32+
33+
## Usage
34+
35+
Add a new task:
36+
37+
```bash
38+
tasknow add "Write documentation"
39+
```
40+
41+
View your current task:
42+
43+
```bash
44+
tasknow
45+
```
46+
47+
Mark the current task as done:
48+
49+
```bash
50+
tasknow done
51+
```
52+
53+
List all tasks:
54+
55+
```bash
56+
tasknow list
57+
```
58+
59+
Remove a task:
60+
61+
```bash
62+
tasknow remove 3
63+
```
64+
65+
Show completed tasks:
66+
67+
```bash
68+
tasknow completed
69+
```
70+
71+
Un-complete a task:
72+
73+
```bash
74+
tasknow undone 3
75+
```
76+
77+
Edit a task:
78+
79+
```bash
80+
tasknow edit 2 "New task description"
81+
```
82+
83+
## Development
84+
85+
Run tests with:
86+
87+
```bash
88+
pytest
89+
```
90+
91+
Generate coverage report:
92+
93+
```bash
94+
pytest --cov=.
95+
```
96+
97+
## License
98+
99+
MIT License © Decoding Chris

0 commit comments

Comments
 (0)