Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/closeio/sync-engine
https://github.com/closeio/sync-engine
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/closeio/sync-engine
- Owner: closeio
- License: agpl-3.0
- Created: 2020-07-09T17:19:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T10:29:56.000Z (2 months ago)
- Last Synced: 2024-11-11T11:30:59.803Z (2 months ago)
- Language: Python
- Size: 27.3 MB
- Stars: 27
- Watchers: 15
- Forks: 9
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sync Engine [](https://circleci.com/gh/closeio/sync-engine)
This is a fork of the Nylas [sync-engine project](https://github.com/nylas/sync-engine).
For those looking for a hosted email syncing service, check out
[their current offerings](https://www.nylas.com/).
### Installation and Setup
TODO: Add Docker steps
Auth an account via the commandline to start syncing:
bin/inbox-auth [email protected]
The `inbox-auth` command will walk you through the process of obtaining an
authorization token from Google or another service for syncing your mail. Your credentials are stored to the local MySQL database for simplicity.
The sync engine will automatically begin syncing your account with the underlying provider. The `inbox-sync` command allows you to manually stop or restart the sync by running `inbox-sync stop [YOUR_ACCOUNT]@example.com` or `inbox-sync start [YOUR_ACCOUNT]@example.com`. Note that an initial sync can take quite a while depending on how much mail you have.
### API Service
The API service provides a REST API for interacting with your data. To start
it in your development environment, run the command below:
```bash
$ bin/inbox-api
```
This will start the API Server on port 5555. At this point **You're now ready to make requests!** If you're using VirtualBox or VMWare fusion with Vagrant, port 5555 has already been forwarded to your host machine, so you can hit the API from your regular web browser.
You can get a list of all connected accounts by requesting `http://localhost:5555/accounts`. This endpoint requires no authentication.
For subsequent requests to retreive mail, contacts, and calendar data, your app should pass the `account_id` value from the previous step as the "username" parameter in HTTP Basic auth. For example:
```
curl --user 'ACCOUNT_ID_VALUE_HERE:' http://localhost:5555/threads
```
If you are using a web browser and would like to clear your cached HTTP Basic Auth values, simply visit http://localhost:5555/logout and click "Cancel".
## Security
For the sake of simplicity and setup speed, the development environment does
not include any authentication or permission. For developing with sensitive
data, we encourage developers to add their own protection, such as only
running sync-engine on a local machine or behind a controlled firewall.
Note that passwords and OAuth tokens are stored unencrypted in the local MySQL data store on disk. This is intentional, for the same reason as above.
## Running tests
To run the test suite execute the following command: `docker-compose run app pytest`
## License
This code is free software, licensed under the The GNU Affero General Public License (AGPL). See the `LICENSE` file for more details.