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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
%global _empty_manifest_terminate_build 0
Name: python-bookstore
Version: 2.5.1
Release: 1
Summary: Storage Workflows for Notebooks
License: BSD
URL: https://github.com/nteract/bookstore
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/35/f8/ffab0bcfda118421e6a72d5f13ca65dbf78e280882fc29bdd9193f4f26b9/bookstore-2.5.1.tar.gz
BuildArch: noarch
Requires: python3-future
Requires: python3-ipython
Requires: python3-notebook
Requires: python3-tornado
Requires: python3-aiobotocore
Requires: python3-aioboto3
Requires: python3-futures
Requires: python3-sphinx
Requires: python3-m2r
Requires: python3-sphinxcontrib-napoleon
Requires: python3-sphinxcontrib-openapi
Requires: python3-codecov
Requires: python3-coverage
Requires: python3-mock
Requires: python3-mypy
Requires: python3-pytest
Requires: python3-pytest-asyncio
Requires: python3-pytest-cov
Requires: python3-pytest-mock
Requires: python3-black
Requires: python3-tox
%description
# bookstore :books:
[](https://bookstore.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/nteract/bookstore)
[](https://circleci.com/gh/nteract/bookstore)
[](https://codecov.io/gh/nteract/bookstore)
**bookstore** :books: provides tooling and workflow recommendations for storing :cd:, scheduling :calendar:, and publishing :book: notebooks.
The full documentation is hosted on [ReadTheDocs](https://bookstore.readthedocs.io).
## How does bookstore work
### Automatic Notebook Versioning
Every *save* of a notebook creates an *immutable copy* of the notebook on object storage.
To simplify implementation, we currently rely on S3 as the object store, using [versioned buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).
<!--
Include diagram for versioning
-->
### Storage Paths
All notebooks are archived to a single versioned S3 bucket with specific prefixes denoting the lifecycle of the notebook:
- `/workspace` - where users edit
- `/published` - public notebooks (to an organization)
Each notebook path is a namespace that an external service ties into the schedule. We archive off versions, keeping the path intact (until a user changes them).
| Prefix | Intent |
|-----------------------------------------|------------------------|
| `/workspace/kylek/notebooks/mine.ipynb` | Notebook in “draft” |
| `/published/kylek/notebooks/mine.ipynb` | Current published copy |
Scheduled notebooks will also be referred to by the notebook key. In addition, we'll need to be able to surface version IDs as well.
### Transitioning to this Storage Plan
Since most people are on a regular filesystem, we'll start with writing to the
`/workspace` prefix as Archival Storage (writing on save using a `post_save_hook`
for a Jupyter contents manager).
### Publishing
The bookstore publishing endpoint is a `serverextension` to the classic Jupyter
server. This means you will need to explicitly enable the `serverextension`
to use the endpoint.
To do so, run:
jupyter serverextension enable --py bookstore
To enable it only for the current environment, run:
jupyter serverextension enable --py bookstore --sys-prefix
## Installation
**bookstore** requires Python 3.6 or higher.
Note: Supports installation on Jupyter servers running Python 3.6 and above.
Your notebooks can still be run in Python 2 or Python 3.
1. Clone this repo.
2. At the repo's root, enter in the Terminal: `python3 -m pip install .` (Tip: don't forget the dot at the end of the command)
## Configuration
```python
# jupyter config
# At ~/.jupyter/jupyter_notebook_config.py for user installs on macOS
# See https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html for other places to plop this
from bookstore import BookstoreContentsArchiver
c.NotebookApp.contents_manager_class = BookstoreContentsArchiver
# All Bookstore settings are centralized on one config object so you don't have to configure it for each class
c.BookstoreSettings.workspace_prefix = "/workspace/kylek/notebooks"
c.BookstoreSettings.published_prefix = "/published/kylek/notebooks"
c.BookstoreSettings.s3_bucket = "<bucket-name>"
# Note: if bookstore is used from an EC2 instance with the right IAM role, you don't
# have to specify these
c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID>
c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>
```
## Developing
If you are developing on bookstore you will want to run the ci tests locally and to make releases.
Use [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about contributing.
Use [running_ci_locally.md](./running_ci_locally.md) to learn more about running ci tests locally.
Use [running_python_tests.md](./running_python_tests.md) to learn about running tests locally.
Use [RELEASING.md](./RELEASING.md) to learn more about releasing bookstore.
%package -n python3-bookstore
Summary: Storage Workflows for Notebooks
Provides: python-bookstore
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-bookstore
# bookstore :books:
[](https://bookstore.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/nteract/bookstore)
[](https://circleci.com/gh/nteract/bookstore)
[](https://codecov.io/gh/nteract/bookstore)
**bookstore** :books: provides tooling and workflow recommendations for storing :cd:, scheduling :calendar:, and publishing :book: notebooks.
The full documentation is hosted on [ReadTheDocs](https://bookstore.readthedocs.io).
## How does bookstore work
### Automatic Notebook Versioning
Every *save* of a notebook creates an *immutable copy* of the notebook on object storage.
To simplify implementation, we currently rely on S3 as the object store, using [versioned buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).
<!--
Include diagram for versioning
-->
### Storage Paths
All notebooks are archived to a single versioned S3 bucket with specific prefixes denoting the lifecycle of the notebook:
- `/workspace` - where users edit
- `/published` - public notebooks (to an organization)
Each notebook path is a namespace that an external service ties into the schedule. We archive off versions, keeping the path intact (until a user changes them).
| Prefix | Intent |
|-----------------------------------------|------------------------|
| `/workspace/kylek/notebooks/mine.ipynb` | Notebook in “draft” |
| `/published/kylek/notebooks/mine.ipynb` | Current published copy |
Scheduled notebooks will also be referred to by the notebook key. In addition, we'll need to be able to surface version IDs as well.
### Transitioning to this Storage Plan
Since most people are on a regular filesystem, we'll start with writing to the
`/workspace` prefix as Archival Storage (writing on save using a `post_save_hook`
for a Jupyter contents manager).
### Publishing
The bookstore publishing endpoint is a `serverextension` to the classic Jupyter
server. This means you will need to explicitly enable the `serverextension`
to use the endpoint.
To do so, run:
jupyter serverextension enable --py bookstore
To enable it only for the current environment, run:
jupyter serverextension enable --py bookstore --sys-prefix
## Installation
**bookstore** requires Python 3.6 or higher.
Note: Supports installation on Jupyter servers running Python 3.6 and above.
Your notebooks can still be run in Python 2 or Python 3.
1. Clone this repo.
2. At the repo's root, enter in the Terminal: `python3 -m pip install .` (Tip: don't forget the dot at the end of the command)
## Configuration
```python
# jupyter config
# At ~/.jupyter/jupyter_notebook_config.py for user installs on macOS
# See https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html for other places to plop this
from bookstore import BookstoreContentsArchiver
c.NotebookApp.contents_manager_class = BookstoreContentsArchiver
# All Bookstore settings are centralized on one config object so you don't have to configure it for each class
c.BookstoreSettings.workspace_prefix = "/workspace/kylek/notebooks"
c.BookstoreSettings.published_prefix = "/published/kylek/notebooks"
c.BookstoreSettings.s3_bucket = "<bucket-name>"
# Note: if bookstore is used from an EC2 instance with the right IAM role, you don't
# have to specify these
c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID>
c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>
```
## Developing
If you are developing on bookstore you will want to run the ci tests locally and to make releases.
Use [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about contributing.
Use [running_ci_locally.md](./running_ci_locally.md) to learn more about running ci tests locally.
Use [running_python_tests.md](./running_python_tests.md) to learn about running tests locally.
Use [RELEASING.md](./RELEASING.md) to learn more about releasing bookstore.
%package help
Summary: Development documents and examples for bookstore
Provides: python3-bookstore-doc
%description help
# bookstore :books:
[](https://bookstore.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/nteract/bookstore)
[](https://circleci.com/gh/nteract/bookstore)
[](https://codecov.io/gh/nteract/bookstore)
**bookstore** :books: provides tooling and workflow recommendations for storing :cd:, scheduling :calendar:, and publishing :book: notebooks.
The full documentation is hosted on [ReadTheDocs](https://bookstore.readthedocs.io).
## How does bookstore work
### Automatic Notebook Versioning
Every *save* of a notebook creates an *immutable copy* of the notebook on object storage.
To simplify implementation, we currently rely on S3 as the object store, using [versioned buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).
<!--
Include diagram for versioning
-->
### Storage Paths
All notebooks are archived to a single versioned S3 bucket with specific prefixes denoting the lifecycle of the notebook:
- `/workspace` - where users edit
- `/published` - public notebooks (to an organization)
Each notebook path is a namespace that an external service ties into the schedule. We archive off versions, keeping the path intact (until a user changes them).
| Prefix | Intent |
|-----------------------------------------|------------------------|
| `/workspace/kylek/notebooks/mine.ipynb` | Notebook in “draft” |
| `/published/kylek/notebooks/mine.ipynb` | Current published copy |
Scheduled notebooks will also be referred to by the notebook key. In addition, we'll need to be able to surface version IDs as well.
### Transitioning to this Storage Plan
Since most people are on a regular filesystem, we'll start with writing to the
`/workspace` prefix as Archival Storage (writing on save using a `post_save_hook`
for a Jupyter contents manager).
### Publishing
The bookstore publishing endpoint is a `serverextension` to the classic Jupyter
server. This means you will need to explicitly enable the `serverextension`
to use the endpoint.
To do so, run:
jupyter serverextension enable --py bookstore
To enable it only for the current environment, run:
jupyter serverextension enable --py bookstore --sys-prefix
## Installation
**bookstore** requires Python 3.6 or higher.
Note: Supports installation on Jupyter servers running Python 3.6 and above.
Your notebooks can still be run in Python 2 or Python 3.
1. Clone this repo.
2. At the repo's root, enter in the Terminal: `python3 -m pip install .` (Tip: don't forget the dot at the end of the command)
## Configuration
```python
# jupyter config
# At ~/.jupyter/jupyter_notebook_config.py for user installs on macOS
# See https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html for other places to plop this
from bookstore import BookstoreContentsArchiver
c.NotebookApp.contents_manager_class = BookstoreContentsArchiver
# All Bookstore settings are centralized on one config object so you don't have to configure it for each class
c.BookstoreSettings.workspace_prefix = "/workspace/kylek/notebooks"
c.BookstoreSettings.published_prefix = "/published/kylek/notebooks"
c.BookstoreSettings.s3_bucket = "<bucket-name>"
# Note: if bookstore is used from an EC2 instance with the right IAM role, you don't
# have to specify these
c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID>
c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>
```
## Developing
If you are developing on bookstore you will want to run the ci tests locally and to make releases.
Use [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about contributing.
Use [running_ci_locally.md](./running_ci_locally.md) to learn more about running ci tests locally.
Use [running_python_tests.md](./running_python_tests.md) to learn about running tests locally.
Use [RELEASING.md](./RELEASING.md) to learn more about releasing bookstore.
%prep
%autosetup -n bookstore-2.5.1
%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-bookstore -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 2.5.1-1
- Package Spec generated
|
