Skip to content

Commit

Permalink
Release 2019.9.16.
Browse files Browse the repository at this point in the history
Updated `CHANGELOG.md` with version 2019.9.16.
Removed the `api.query()`-based todoist_today_or_overdue CLI entrypoint.
The `query` api method has been deprecated, so most of the `ad-hoc` CLI methods do not actually work anymore.
Also removed `todoist-adhoc`, so there is only one entry point for the ad-hoc CLI, `todoist-adhoc-cli`.
Also fixed a NameError in `config.store_default_user_config()`.
  • Loading branch information
scholer committed Sep 16, 2019
1 parent 3c68237 commit 1280988
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 10 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@


Version 2019.09.10:
-------------------

### `todoist-action-cli` changes:

* Fixed issue where custom label fields weren't added after `-sync`. This was particularly
noticeable after deleting the cache.


### Other changes:

* Package install now requires `todoist-python` version 8.0.0 or above to prevent install
with old versions of todoist-python.
* Removed `todoist_today_or_overdue` and `todoist-adhoc` entry points (executables).
There is still the `todoist-adhoc-cli` alias, but many of the commands are now broken,
since Todoist deprecated the adhoc query endpoint.


*For developer-relevant code changes, please check the git commit log.*




Version 2019.09.10:
-------------------

Expand Down
48 changes: 43 additions & 5 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@ Publishing takes the following steps:
2. Make a tagged release on GitHub.


### Summary:

```cmd
python setup.py sdist bdist_wheel
twine check dist/*
twine upload testpypi dist/*
twine upload dist/*
git commit -m "Release <version>."
git tag -a "Release <version>".
git push --tags
```

Check:

* https://test.pypi.org/project/actionista-todoist/
* https://pypi.org/project/actionista-todoist/
* https://github.com/scholer/actionista-todoist/releases




### Create PyPI distribution release:


Expand All @@ -27,6 +51,8 @@ Test the package by uploading to test server, using either setuptools or twine:

$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Check the project page on the test server: https://test.pypi.org/project/actionista-todoist/

Upload the distribution package to PyPI, using either setuptools or twine:

$ twine upload dist/*
Expand Down Expand Up @@ -77,7 +103,7 @@ Two options:
Documentations:
---------------

Documentation options:
Documentation options, overview:

* Sphinx + ReadTheDocs - now with "reasonable" Markdown support.
* MkDocs + GitHub Pages.
Expand All @@ -86,24 +112,36 @@ Documentation options:
* With GitHub pages, the docs lives in a separate branch of your
repository, `gh-pages` by default. You can publish docs with MkDocs directly to
gh-pages using `mkdocs gh-deploy`.
* You can also use MkDocs with ReadTheDocs:
* MkDocs + ReadTheDocs:
https://read-the-docs.readthedocs.io/en/latest/intro/getting-started-with-mkdocs.html.




### MkDocs:

1. Init new project using: `mkdocs new .`
Local initialization, building and serving:

1. Init new project using: `mkdocs new .`. This will create a `mkdocs.yml` configuration file.
2. Edit `index.md` and add other doc files.
3. Serve locally, `mkdocs serve`.
4. Edit `mkdocs.yml`, updating `site_name:` and `nav:` (and optionally `theme:`).
5. Build: `mkdocs build`.
* Add `site/` to `.gitignore` if you haven't done so already.
`echo "site/" >> .gitignore`.
6. Deploy as GitHub Pages: `mkdocs gh-deploy`.
7. Alternatively, configure your ReadTheDocs to import your

MkDocs deployment, options:

1. Deploy as GitHub Pages: `mkdocs gh-deploy`.
2. Import to ReadTheDocs.


### MkDocs + ReadTheDocs

I've imported this project to ReadTheDocs.
Since I use GitHub to authenticate with ReadTheDocs, a webhook was automatically configured,
so ReadTheDocs are updated every time I push to GitHub.

I'm also using a `.readthedocs.yml` file in my project root to configure ReadTheDocs.
This just specifies the configuration file version, and which mkdocs config file to use.
(This could also have been configured during ReadTheDocs project import.)
2 changes: 1 addition & 1 deletion actionista/todoist/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def store_default_user_config(overwrite_existing=False):
elif overwrite_existing is None:
overwrite = (input("Do you want to overwrite the current config? [Y/n]").lower() or 'y')[0] == 'y'
else:
raise ValueError(f"Value '{value}' of argument 'overwrite_existing' not recognized. "
raise ValueError(f"Value '{overwrite_existing}' of argument 'overwrite_existing' not recognized. "
"Must be one of True/False/None.")
if not overwrite:
print(" - Skipping.")
Expand Down
7 changes: 3 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,15 @@
'todoist-add-task=actionista.todoist.todoist_cli:add_task_cli',

# Entry points for adhoc_cli commands (argparse-based):
'todoist-adhoc=actionista.todoist.adhoc_cli:main',
'todoist-adhoc-cli=actionista.todoist.adhoc_cli:main', # alias
'todoist_today_or_overdue=actionista.todoist.adhoc_cli:print_today_or_overdue_tasks',
# 'todoist-adhoc=actionista.todoist.adhoc_cli:main',
'todoist-adhoc-cli=actionista.todoist.adhoc_cli:main',
],
# 'gui_scripts': [
# ]
},
# pip will install these modules as requirements.
install_requires=[
'todoist-python>=8.0', # official Todoist python API from Doist
'todoist-python>=8.0', # Official Todoist python API from Doist
'pyyaml', # Config loading.
'pytz', # Timezone support.
'python-dateutil', # Parsing ISO timestamps.
Expand Down

0 comments on commit 1280988

Please sign in to comment.