Table of Contents
Table of Contents
Getting Started
Installation
Install the app from Pypi:
# Install using pip
pip install sync-my-tasks
# Run it
sync-my-tasks -h
sync-my-tasks.
Usage:
sync-my-tasks (--from-asana --asana-workspace=<name> [--asana-token-file PATH]) (--to-mstodo)
sync-my-tasks (-h | --help)
sync-my-tasks --version
Options:
-h --help Show this screen.
--version Show version.
--from-asana Pull tasks from Asana.
--asana-workspace=<name> Name of workspace
--asana-token-file PATH Path to file containing the Asana Personal token. [default: ./asana-token]
--to-mstodo Push tasks to Microsoft To-Do.
Manual Installation:
- Clone the repo:
git clone https://github.com/wilrnh/sync-my-tasks.git
- Install dependencies:
poetry install
- Start the app:
python sync-my-tasks/command.py
Usage
Asana
Microsoft To-Do
Development
Architecture
sync-my-tasks is a CLI tool that copies tasks between apps. Since different apps provide varying APIs for the import and export of tasks, sync-my-tasks abstracts their functionality into providers which are in charge of interfacing with their respective APIs and handling import and export.
Each provider is responsible for either importing or exporting a well defined list
of TaskList
s, or both.
TaskList
: a named list
of Task
s Task
: an object representing a task, that is generic enough to be imported/exported between any provider.
Deployment
Github Actions will automcatically build and deploy releases to Pypi.
Contribute
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Please feel free to ask questions! Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.