summaryrefslogtreecommitdiff
path: root/python-todoist-python.spec
blob: 8f1176491712c3f9231bdca7ef623aaa4b07ac78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
%global _empty_manifest_terminate_build 0
Name:		python-todoist-python
Version:	8.1.4
Release:	1
Summary:	todoist-python - The official Todoist Python API library
License:	MIT
URL:		https://pypi.org/project/todoist-python/
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ed/f1/d2e361e5dac20fe33ecde22d1d738ff4632564487e753a9a429cb70d6aa6/todoist-python-8.1.4.tar.gz
BuildArch:	noarch

Requires:	python3-requests
Requires:	python3-typing

%description
# The official Todoist Python API library
Welcome to the official client to the [Todoist Sync API](https://developer.todoist.com/sync/).
This client makes actions using the Sync API easier to use and also caches
values locally to make right usage of the partial sync mechanism of the API.
## Installing
The package can be installed as any other pip package:
```bash
pip install todoist-python
```
The official Documentation can be found at
https://todoist-python.readthedocs.io/en/latest/.
## Using
You can import `todoist-python` on your Python application or just try it out
from the python REPL (read-eval-print-loop).
This is how it looks like when using the REPL:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> api.sync()
>>> full_name = api.state['user']['full_name']
>>> print(full_name)
John Doe
>>> for project in api.state['projects']:
Personal
Shopping
Work
Errands
Movies to watch
```
The `state` attribute has all the data of your full sync and the `sync` method
does the job of keeping things in sync in the best way possible.
You can add or change data as well. Let's add a task and change it as examples:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> item = api.items.add('My taks')  # oh no, typo!
>>> api.commit()  # commit the changes to the server
{'id': 1234567890, u'content': u'My taks', u'user_id': 1, ...}
>>>
>>> api.items.update(item['id'], content='My task')
>>> api.commit()  # never forget to commit!
{'id': 1234567890, u'content': u'My task', u'user_id': 1, ...}
```
That's it! To know what actions are available for each object, refer to
`Managers` in our [official documentation](https://todoist-python.readthedocs.io).
We also document all the actions available on this library along with our
official API documentation. Here is one example of the [add task
endpoint](https://developer.todoist.com/sync/v8/?python#add-an-item). Check the
_python_ tab on the examples for actions related to this library.
## Development
### Build Project
This project still supports Python 2.7 but **we recommend Python 3**.
We recommend using [virtualenv](https://pypi.python.org/pypi/virtualenv) and
[pip](https://pypi.python.org/pypi/pip) for the project bootstrap. Below is a
step by step of the bootstrap process:
Clone the repo and enter it:
    $ git clone git@github.com:Doist/todoist-python.git ; cd todoist-python
Create an environment:
    $ virtualenv --system-site-packages -p /usr/bin/python2.7 env # if you need python2.7
    $ virtualenv --system-site-packages env # use only python3 if you run this
Activate the environment:
    $ source env/bin/activate
Install the library along with all the dependencies (just `requests` for this project):
    $ pip install -e .
### Build Documentation
If you want to build the documentation as well, install some extra packages:
    $ pip install -r doc/requirements.txt
Build the documentation:
    $ (cd doc ; make html)
Read the built documentation by opening:
    doc/_build/html/index.html
## Testing the library
We have a set of tests to ensure we support Python both 2.x and 3.x.
To test it out, please make sure you have python 2 and python 3 installed in
your system. Then install "tox" either globally (preferred way) or in your local
environment.
    # apt-get install python-tox
or
    $ pip install tox
You will also need to have the `pytest.ini` file. We are providing a
`pytest.ini.sample` that you can copy and paste to create your own
`pytest.ini`.
You will need two different tokens (`token` and `token2` keys on on
`pytest.ini`) to be able to run all the tests successfully, since we have tests
for the sharing features.
With the setup done, you can just run:
    $ tox
Keep in mind that running the whole test suit may cause some tests to fail as
you will certaily hit some limits of API usage. We recommend only running the
test for your feature.

%package -n python3-todoist-python
Summary:	todoist-python - The official Todoist Python API library
Provides:	python-todoist-python
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-todoist-python
# The official Todoist Python API library
Welcome to the official client to the [Todoist Sync API](https://developer.todoist.com/sync/).
This client makes actions using the Sync API easier to use and also caches
values locally to make right usage of the partial sync mechanism of the API.
## Installing
The package can be installed as any other pip package:
```bash
pip install todoist-python
```
The official Documentation can be found at
https://todoist-python.readthedocs.io/en/latest/.
## Using
You can import `todoist-python` on your Python application or just try it out
from the python REPL (read-eval-print-loop).
This is how it looks like when using the REPL:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> api.sync()
>>> full_name = api.state['user']['full_name']
>>> print(full_name)
John Doe
>>> for project in api.state['projects']:
Personal
Shopping
Work
Errands
Movies to watch
```
The `state` attribute has all the data of your full sync and the `sync` method
does the job of keeping things in sync in the best way possible.
You can add or change data as well. Let's add a task and change it as examples:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> item = api.items.add('My taks')  # oh no, typo!
>>> api.commit()  # commit the changes to the server
{'id': 1234567890, u'content': u'My taks', u'user_id': 1, ...}
>>>
>>> api.items.update(item['id'], content='My task')
>>> api.commit()  # never forget to commit!
{'id': 1234567890, u'content': u'My task', u'user_id': 1, ...}
```
That's it! To know what actions are available for each object, refer to
`Managers` in our [official documentation](https://todoist-python.readthedocs.io).
We also document all the actions available on this library along with our
official API documentation. Here is one example of the [add task
endpoint](https://developer.todoist.com/sync/v8/?python#add-an-item). Check the
_python_ tab on the examples for actions related to this library.
## Development
### Build Project
This project still supports Python 2.7 but **we recommend Python 3**.
We recommend using [virtualenv](https://pypi.python.org/pypi/virtualenv) and
[pip](https://pypi.python.org/pypi/pip) for the project bootstrap. Below is a
step by step of the bootstrap process:
Clone the repo and enter it:
    $ git clone git@github.com:Doist/todoist-python.git ; cd todoist-python
Create an environment:
    $ virtualenv --system-site-packages -p /usr/bin/python2.7 env # if you need python2.7
    $ virtualenv --system-site-packages env # use only python3 if you run this
Activate the environment:
    $ source env/bin/activate
Install the library along with all the dependencies (just `requests` for this project):
    $ pip install -e .
### Build Documentation
If you want to build the documentation as well, install some extra packages:
    $ pip install -r doc/requirements.txt
Build the documentation:
    $ (cd doc ; make html)
Read the built documentation by opening:
    doc/_build/html/index.html
## Testing the library
We have a set of tests to ensure we support Python both 2.x and 3.x.
To test it out, please make sure you have python 2 and python 3 installed in
your system. Then install "tox" either globally (preferred way) or in your local
environment.
    # apt-get install python-tox
or
    $ pip install tox
You will also need to have the `pytest.ini` file. We are providing a
`pytest.ini.sample` that you can copy and paste to create your own
`pytest.ini`.
You will need two different tokens (`token` and `token2` keys on on
`pytest.ini`) to be able to run all the tests successfully, since we have tests
for the sharing features.
With the setup done, you can just run:
    $ tox
Keep in mind that running the whole test suit may cause some tests to fail as
you will certaily hit some limits of API usage. We recommend only running the
test for your feature.

%package help
Summary:	Development documents and examples for todoist-python
Provides:	python3-todoist-python-doc
%description help
# The official Todoist Python API library
Welcome to the official client to the [Todoist Sync API](https://developer.todoist.com/sync/).
This client makes actions using the Sync API easier to use and also caches
values locally to make right usage of the partial sync mechanism of the API.
## Installing
The package can be installed as any other pip package:
```bash
pip install todoist-python
```
The official Documentation can be found at
https://todoist-python.readthedocs.io/en/latest/.
## Using
You can import `todoist-python` on your Python application or just try it out
from the python REPL (read-eval-print-loop).
This is how it looks like when using the REPL:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> api.sync()
>>> full_name = api.state['user']['full_name']
>>> print(full_name)
John Doe
>>> for project in api.state['projects']:
Personal
Shopping
Work
Errands
Movies to watch
```
The `state` attribute has all the data of your full sync and the `sync` method
does the job of keeping things in sync in the best way possible.
You can add or change data as well. Let's add a task and change it as examples:
```python
$ python
>>> import todoist
>>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567')
>>> item = api.items.add('My taks')  # oh no, typo!
>>> api.commit()  # commit the changes to the server
{'id': 1234567890, u'content': u'My taks', u'user_id': 1, ...}
>>>
>>> api.items.update(item['id'], content='My task')
>>> api.commit()  # never forget to commit!
{'id': 1234567890, u'content': u'My task', u'user_id': 1, ...}
```
That's it! To know what actions are available for each object, refer to
`Managers` in our [official documentation](https://todoist-python.readthedocs.io).
We also document all the actions available on this library along with our
official API documentation. Here is one example of the [add task
endpoint](https://developer.todoist.com/sync/v8/?python#add-an-item). Check the
_python_ tab on the examples for actions related to this library.
## Development
### Build Project
This project still supports Python 2.7 but **we recommend Python 3**.
We recommend using [virtualenv](https://pypi.python.org/pypi/virtualenv) and
[pip](https://pypi.python.org/pypi/pip) for the project bootstrap. Below is a
step by step of the bootstrap process:
Clone the repo and enter it:
    $ git clone git@github.com:Doist/todoist-python.git ; cd todoist-python
Create an environment:
    $ virtualenv --system-site-packages -p /usr/bin/python2.7 env # if you need python2.7
    $ virtualenv --system-site-packages env # use only python3 if you run this
Activate the environment:
    $ source env/bin/activate
Install the library along with all the dependencies (just `requests` for this project):
    $ pip install -e .
### Build Documentation
If you want to build the documentation as well, install some extra packages:
    $ pip install -r doc/requirements.txt
Build the documentation:
    $ (cd doc ; make html)
Read the built documentation by opening:
    doc/_build/html/index.html
## Testing the library
We have a set of tests to ensure we support Python both 2.x and 3.x.
To test it out, please make sure you have python 2 and python 3 installed in
your system. Then install "tox" either globally (preferred way) or in your local
environment.
    # apt-get install python-tox
or
    $ pip install tox
You will also need to have the `pytest.ini` file. We are providing a
`pytest.ini.sample` that you can copy and paste to create your own
`pytest.ini`.
You will need two different tokens (`token` and `token2` keys on on
`pytest.ini`) to be able to run all the tests successfully, since we have tests
for the sharing features.
With the setup done, you can just run:
    $ tox
Keep in mind that running the whole test suit may cause some tests to fail as
you will certaily hit some limits of API usage. We recommend only running the
test for your feature.

%prep
%autosetup -n todoist-python-8.1.4

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-todoist-python -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 8.1.4-1
- Package Spec generated