summaryrefslogtreecommitdiff
path: root/python-bandersnatch.spec
blob: 9e8699d666936aec3ab68e489fdf59d527fb53ed (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
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
%global _empty_manifest_terminate_build 0
Name:		python-bandersnatch
Version:	6.3.0
Release:	1
Summary:	Mirroring tool that implements the client (mirror) side of PEP 381
License:	Academic Free License, version 3
URL:		https://github.com/pypa/bandersnatch/
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/f4/3a/5ab09d852955a1acae22d6ce79b4a91eca7f8684e3b2fa953d6b7d750348/bandersnatch-6.3.0.tar.gz
BuildArch:	noarch

Requires:	python3-aiohttp
Requires:	python3-aiohttp-socks
Requires:	python3-aiohttp-xmlrpc
Requires:	python3-filelock
Requires:	python3-humanfriendly
Requires:	python3-packaging
Requires:	python3-setuptools
Requires:	python3-s3path
Requires:	python3-bandersnatch-safety-db
Requires:	python3-keystoneauth1
Requires:	python3-openstackclient
Requires:	python3-swiftclient
Requires:	python3-uvloop

%description
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Actions Status](https://github.com/pypa/bandersnatch/workflows/bandersnatch_ci/badge.svg)](https://github.com/pypa/bandersnatch/actions)
[![codecov.io](https://codecov.io/github/pypa/bandersnatch/coverage.svg?branch=master)](https://codecov.io/github/pypa/bandersnatch)
[![Documentation Status](https://readthedocs.org/projects/bandersnatch/badge/?version=latest)](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/bandersnatch)](https://pepy.tech/project/bandersnatch)

______________________________________________________________________

This is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`
<http://www.python.org/dev/peps/pep-0381/>.

- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*
- [Documentation](https://bandersnatch.readthedocs.io/en/latest/)

**bandersnatch maintainers** are looking for more **help**! Please refer to our
[MAINTAINER](https://github.com/pypa/bandersnatch/blob/master/MAINTAINERS.md)
documentation to see the roles and responsibilities. We would also
ask you read our **Mission Statement** to ensure it aligns with your thoughts for
this project.

- If interested contact @cooperlees

## Installation

The following instructions will place the bandersnatch executable in a
virtualenv under `bandersnatch/bin/bandersnatch`.

- bandersnatch **requires** `>= Python 3.8.0`

## Docker

This will pull latest build. Please use a specific tag if desired.

- Docker image includes `/bandersnatch/src/runner.py` to periodically
  run a `bandersnatch mirror`
  - Please `/bandersnatch/src/runner.py --help` for usage
- With docker, we recommend bind mounting in a read only `bandersnatch.conf`
  - Defaults to `/conf/bandersnatch.conf`

```shell
docker pull pypa/bandersnatch
docker run pypa/bandersnatch bandersnatch --help
```

### pip

This installs the latest stable, released version.

```shell
python3 -m venv bandersnatch
bandersnatch/bin/pip install bandersnatch
bandersnatch/bin/bandersnatch --help
```

## Quickstart

- Run `bandersnatch mirror` - it will create an empty configuration file
  for you in `/etc/bandersnatch.conf`.
- Review `/etc/bandersnatch.conf` and adapt to your needs.
- Run `bandersnatch mirror` again. It will populate your mirror with the
  current status of all PyPI packages.
  Current mirror package size can be seen here: <https://pypi.org/stats/>
- A `blocklist` or `allowlist` can be created to cut down your mirror size.
  You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)
  to determine which packages to add to your list.
- Run `bandersnatch mirror` regularly to update your mirror with any
  intermediate changes.

### Webserver

Configure your webserver to serve the `web/` sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.

For an [nginx](https://www.nginx.com/) example, please look at our
[banderx](https://github.com/pypa/bandersnatch/tree/main/src/banderx)
docker container and [nginx.conf](https://github.com/pypa/bandersnatch/blob/main/src/banderx/nginx.conf)
example configuration.

- Note that it is a good idea to have your webserver publish the HTML index
  files correctly with UTF-8 as the charset. The index pages will work without
  it but if humans look at the pages the characters will end up looking funny.

- Make sure that the webserver uses UTF-8 to look up unicode path names. nginx
  gets this right by default - not sure about others.

For more information visit out [official documentation](https://bandersnatch.readthedocs.io/)
for instructions on how to use a NGINX example Docker Image.

If you are looking to an docker-compose example head over [here](https://github.com/pypa/bandersnatch/tree/main/src/bandersnatch_docker_compose)

### Cron jobs

You need to set up one cron job to run the mirror itself.

Here's a sample that you could place in `/etc/cron.d/bandersnatch`:

```cron
    LC_ALL=en_US.utf8
    */2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]
```

This assumes that you have a `logger` utility installed that will convert the
output of the commands to syslog entries.

[SystemD Timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
are also another alternative in today's modern world.

### Maintenance

bandersnatch does not keep much local state in addition to the mirrored data.
In general you can just keep rerunning `bandersnatch mirror` to make it fix
errors.

If you want to force bandersnatch to check everything against the master PyPI:

- run `bandersnatch mirror --force-check` to move status files if they exist in your mirror directory in order get a full sync.

Be aware that full syncs likely take hours depending on PyPI's performance and your network latency and bandwidth.

#### Other Commands

- `bandersnatch delete --help` - Allows you to specify package(s) to be removed from your mirror (*dangerous*)
- `bandersnatch verify --help` - Crawls your repo and fixes any missed files + deletes any unowned files found (*dangerous*)

### Operational notes

#### Case-sensitive filesystem needed

You need to run bandersnatch on a case-sensitive filesystem.

OS X natively does this OK even though the filesystem is not strictly
case-sensitive and bandersnatch will work fine when running on OS X. However,
tarring a bandersnatch data directory and moving it to, e.g. Linux with a
case-sensitive filesystem will lead to inconsistencies. You can fix those by
deleting the status files and have bandersnatch run a full check on your data.

#### Windows requires elevated prompt

Bandersnatch makes use of symbolic links. On Windows, this permission is turned off by default for non-admin users. In order to run bandersnatch on Windows either call it from an elevated command prompt (i.e. right-click, run-as Administrator) or give yourself symlink permissions in the group policy editor.

#### Many sub-directories needed

The PyPI has a quite extensive list of packages that we need to maintain in a
flat directory. Filesystems with small limits on the number of sub-directories
per directory can run into a problem like this:

```console
    2013-07-09 16:11:33,331 ERROR: Error syncing package: zweb@802449
    OSError: [Errno 31] Too many links: '../pypi/web/simple/zweb'
```

Specifically we recommend to avoid using ext3. Ext4 and newer does not have the
limitation of 32k sub-directories.

#### Client Compatibility

A bandersnatch static mirror is compatible only to the "static",  cacheable
parts of PyPI that are needed to support package installation. It does not
support more dynamic APIs of PyPI that maybe be used by various clients for
other purposes.

An example of an unsupported API is [PyPI's XML-RPC interface](https://warehouse.readthedocs.io/api-reference/xml-rpc/), which is used when running `pip search`.

### Bandersnatch Mission

The bandersnatch project strives to:

- Mirror all static objects of the Python Package Index (<https://pypi.org/>)
- bandersnatch's main goal is to support the main global index to local syncing **only**
- This will allow organizations to have lower latency access to PyPI and
  save bandwidth on their WAN connections and more importantly the PyPI CDN
- Custom features and requests may be accepted if they can be of a *plugin* form
  - e.g. refer to the `blocklist` and `allowlist` plugins

### Contact

If you have questions or comments, please submit a bug report to
<https://github.com/pypa/bandersnatch/issues/new>

- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit <https://discord.com/invite/pypa>

### Code of Conduct

Everyone interacting in the bandersnatch project's codebases, issue trackers,
chat rooms, and mailing lists is expected to follow the
[PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).

### Kudos

This client is based on the original pep381client by *Martin v. Loewis*.

*Richard Jones* was very patient answering questions at PyCon 2013 and made the
protocol more reliable by implementing some PyPI enhancements.

*Christian Theune* for creating and maintaining `bandersnatch` for many years!


%package -n python3-bandersnatch
Summary:	Mirroring tool that implements the client (mirror) side of PEP 381
Provides:	python-bandersnatch
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-bandersnatch
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Actions Status](https://github.com/pypa/bandersnatch/workflows/bandersnatch_ci/badge.svg)](https://github.com/pypa/bandersnatch/actions)
[![codecov.io](https://codecov.io/github/pypa/bandersnatch/coverage.svg?branch=master)](https://codecov.io/github/pypa/bandersnatch)
[![Documentation Status](https://readthedocs.org/projects/bandersnatch/badge/?version=latest)](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/bandersnatch)](https://pepy.tech/project/bandersnatch)

______________________________________________________________________

This is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`
<http://www.python.org/dev/peps/pep-0381/>.

- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*
- [Documentation](https://bandersnatch.readthedocs.io/en/latest/)

**bandersnatch maintainers** are looking for more **help**! Please refer to our
[MAINTAINER](https://github.com/pypa/bandersnatch/blob/master/MAINTAINERS.md)
documentation to see the roles and responsibilities. We would also
ask you read our **Mission Statement** to ensure it aligns with your thoughts for
this project.

- If interested contact @cooperlees

## Installation

The following instructions will place the bandersnatch executable in a
virtualenv under `bandersnatch/bin/bandersnatch`.

- bandersnatch **requires** `>= Python 3.8.0`

## Docker

This will pull latest build. Please use a specific tag if desired.

- Docker image includes `/bandersnatch/src/runner.py` to periodically
  run a `bandersnatch mirror`
  - Please `/bandersnatch/src/runner.py --help` for usage
- With docker, we recommend bind mounting in a read only `bandersnatch.conf`
  - Defaults to `/conf/bandersnatch.conf`

```shell
docker pull pypa/bandersnatch
docker run pypa/bandersnatch bandersnatch --help
```

### pip

This installs the latest stable, released version.

```shell
python3 -m venv bandersnatch
bandersnatch/bin/pip install bandersnatch
bandersnatch/bin/bandersnatch --help
```

## Quickstart

- Run `bandersnatch mirror` - it will create an empty configuration file
  for you in `/etc/bandersnatch.conf`.
- Review `/etc/bandersnatch.conf` and adapt to your needs.
- Run `bandersnatch mirror` again. It will populate your mirror with the
  current status of all PyPI packages.
  Current mirror package size can be seen here: <https://pypi.org/stats/>
- A `blocklist` or `allowlist` can be created to cut down your mirror size.
  You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)
  to determine which packages to add to your list.
- Run `bandersnatch mirror` regularly to update your mirror with any
  intermediate changes.

### Webserver

Configure your webserver to serve the `web/` sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.

For an [nginx](https://www.nginx.com/) example, please look at our
[banderx](https://github.com/pypa/bandersnatch/tree/main/src/banderx)
docker container and [nginx.conf](https://github.com/pypa/bandersnatch/blob/main/src/banderx/nginx.conf)
example configuration.

- Note that it is a good idea to have your webserver publish the HTML index
  files correctly with UTF-8 as the charset. The index pages will work without
  it but if humans look at the pages the characters will end up looking funny.

- Make sure that the webserver uses UTF-8 to look up unicode path names. nginx
  gets this right by default - not sure about others.

For more information visit out [official documentation](https://bandersnatch.readthedocs.io/)
for instructions on how to use a NGINX example Docker Image.

If you are looking to an docker-compose example head over [here](https://github.com/pypa/bandersnatch/tree/main/src/bandersnatch_docker_compose)

### Cron jobs

You need to set up one cron job to run the mirror itself.

Here's a sample that you could place in `/etc/cron.d/bandersnatch`:

```cron
    LC_ALL=en_US.utf8
    */2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]
```

This assumes that you have a `logger` utility installed that will convert the
output of the commands to syslog entries.

[SystemD Timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
are also another alternative in today's modern world.

### Maintenance

bandersnatch does not keep much local state in addition to the mirrored data.
In general you can just keep rerunning `bandersnatch mirror` to make it fix
errors.

If you want to force bandersnatch to check everything against the master PyPI:

- run `bandersnatch mirror --force-check` to move status files if they exist in your mirror directory in order get a full sync.

Be aware that full syncs likely take hours depending on PyPI's performance and your network latency and bandwidth.

#### Other Commands

- `bandersnatch delete --help` - Allows you to specify package(s) to be removed from your mirror (*dangerous*)
- `bandersnatch verify --help` - Crawls your repo and fixes any missed files + deletes any unowned files found (*dangerous*)

### Operational notes

#### Case-sensitive filesystem needed

You need to run bandersnatch on a case-sensitive filesystem.

OS X natively does this OK even though the filesystem is not strictly
case-sensitive and bandersnatch will work fine when running on OS X. However,
tarring a bandersnatch data directory and moving it to, e.g. Linux with a
case-sensitive filesystem will lead to inconsistencies. You can fix those by
deleting the status files and have bandersnatch run a full check on your data.

#### Windows requires elevated prompt

Bandersnatch makes use of symbolic links. On Windows, this permission is turned off by default for non-admin users. In order to run bandersnatch on Windows either call it from an elevated command prompt (i.e. right-click, run-as Administrator) or give yourself symlink permissions in the group policy editor.

#### Many sub-directories needed

The PyPI has a quite extensive list of packages that we need to maintain in a
flat directory. Filesystems with small limits on the number of sub-directories
per directory can run into a problem like this:

```console
    2013-07-09 16:11:33,331 ERROR: Error syncing package: zweb@802449
    OSError: [Errno 31] Too many links: '../pypi/web/simple/zweb'
```

Specifically we recommend to avoid using ext3. Ext4 and newer does not have the
limitation of 32k sub-directories.

#### Client Compatibility

A bandersnatch static mirror is compatible only to the "static",  cacheable
parts of PyPI that are needed to support package installation. It does not
support more dynamic APIs of PyPI that maybe be used by various clients for
other purposes.

An example of an unsupported API is [PyPI's XML-RPC interface](https://warehouse.readthedocs.io/api-reference/xml-rpc/), which is used when running `pip search`.

### Bandersnatch Mission

The bandersnatch project strives to:

- Mirror all static objects of the Python Package Index (<https://pypi.org/>)
- bandersnatch's main goal is to support the main global index to local syncing **only**
- This will allow organizations to have lower latency access to PyPI and
  save bandwidth on their WAN connections and more importantly the PyPI CDN
- Custom features and requests may be accepted if they can be of a *plugin* form
  - e.g. refer to the `blocklist` and `allowlist` plugins

### Contact

If you have questions or comments, please submit a bug report to
<https://github.com/pypa/bandersnatch/issues/new>

- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit <https://discord.com/invite/pypa>

### Code of Conduct

Everyone interacting in the bandersnatch project's codebases, issue trackers,
chat rooms, and mailing lists is expected to follow the
[PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).

### Kudos

This client is based on the original pep381client by *Martin v. Loewis*.

*Richard Jones* was very patient answering questions at PyCon 2013 and made the
protocol more reliable by implementing some PyPI enhancements.

*Christian Theune* for creating and maintaining `bandersnatch` for many years!


%package help
Summary:	Development documents and examples for bandersnatch
Provides:	python3-bandersnatch-doc
%description help
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Actions Status](https://github.com/pypa/bandersnatch/workflows/bandersnatch_ci/badge.svg)](https://github.com/pypa/bandersnatch/actions)
[![codecov.io](https://codecov.io/github/pypa/bandersnatch/coverage.svg?branch=master)](https://codecov.io/github/pypa/bandersnatch)
[![Documentation Status](https://readthedocs.org/projects/bandersnatch/badge/?version=latest)](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/bandersnatch)](https://pepy.tech/project/bandersnatch)

______________________________________________________________________

This is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`
<http://www.python.org/dev/peps/pep-0381/>.

- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*
- [Documentation](https://bandersnatch.readthedocs.io/en/latest/)

**bandersnatch maintainers** are looking for more **help**! Please refer to our
[MAINTAINER](https://github.com/pypa/bandersnatch/blob/master/MAINTAINERS.md)
documentation to see the roles and responsibilities. We would also
ask you read our **Mission Statement** to ensure it aligns with your thoughts for
this project.

- If interested contact @cooperlees

## Installation

The following instructions will place the bandersnatch executable in a
virtualenv under `bandersnatch/bin/bandersnatch`.

- bandersnatch **requires** `>= Python 3.8.0`

## Docker

This will pull latest build. Please use a specific tag if desired.

- Docker image includes `/bandersnatch/src/runner.py` to periodically
  run a `bandersnatch mirror`
  - Please `/bandersnatch/src/runner.py --help` for usage
- With docker, we recommend bind mounting in a read only `bandersnatch.conf`
  - Defaults to `/conf/bandersnatch.conf`

```shell
docker pull pypa/bandersnatch
docker run pypa/bandersnatch bandersnatch --help
```

### pip

This installs the latest stable, released version.

```shell
python3 -m venv bandersnatch
bandersnatch/bin/pip install bandersnatch
bandersnatch/bin/bandersnatch --help
```

## Quickstart

- Run `bandersnatch mirror` - it will create an empty configuration file
  for you in `/etc/bandersnatch.conf`.
- Review `/etc/bandersnatch.conf` and adapt to your needs.
- Run `bandersnatch mirror` again. It will populate your mirror with the
  current status of all PyPI packages.
  Current mirror package size can be seen here: <https://pypi.org/stats/>
- A `blocklist` or `allowlist` can be created to cut down your mirror size.
  You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)
  to determine which packages to add to your list.
- Run `bandersnatch mirror` regularly to update your mirror with any
  intermediate changes.

### Webserver

Configure your webserver to serve the `web/` sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.

For an [nginx](https://www.nginx.com/) example, please look at our
[banderx](https://github.com/pypa/bandersnatch/tree/main/src/banderx)
docker container and [nginx.conf](https://github.com/pypa/bandersnatch/blob/main/src/banderx/nginx.conf)
example configuration.

- Note that it is a good idea to have your webserver publish the HTML index
  files correctly with UTF-8 as the charset. The index pages will work without
  it but if humans look at the pages the characters will end up looking funny.

- Make sure that the webserver uses UTF-8 to look up unicode path names. nginx
  gets this right by default - not sure about others.

For more information visit out [official documentation](https://bandersnatch.readthedocs.io/)
for instructions on how to use a NGINX example Docker Image.

If you are looking to an docker-compose example head over [here](https://github.com/pypa/bandersnatch/tree/main/src/bandersnatch_docker_compose)

### Cron jobs

You need to set up one cron job to run the mirror itself.

Here's a sample that you could place in `/etc/cron.d/bandersnatch`:

```cron
    LC_ALL=en_US.utf8
    */2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]
```

This assumes that you have a `logger` utility installed that will convert the
output of the commands to syslog entries.

[SystemD Timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
are also another alternative in today's modern world.

### Maintenance

bandersnatch does not keep much local state in addition to the mirrored data.
In general you can just keep rerunning `bandersnatch mirror` to make it fix
errors.

If you want to force bandersnatch to check everything against the master PyPI:

- run `bandersnatch mirror --force-check` to move status files if they exist in your mirror directory in order get a full sync.

Be aware that full syncs likely take hours depending on PyPI's performance and your network latency and bandwidth.

#### Other Commands

- `bandersnatch delete --help` - Allows you to specify package(s) to be removed from your mirror (*dangerous*)
- `bandersnatch verify --help` - Crawls your repo and fixes any missed files + deletes any unowned files found (*dangerous*)

### Operational notes

#### Case-sensitive filesystem needed

You need to run bandersnatch on a case-sensitive filesystem.

OS X natively does this OK even though the filesystem is not strictly
case-sensitive and bandersnatch will work fine when running on OS X. However,
tarring a bandersnatch data directory and moving it to, e.g. Linux with a
case-sensitive filesystem will lead to inconsistencies. You can fix those by
deleting the status files and have bandersnatch run a full check on your data.

#### Windows requires elevated prompt

Bandersnatch makes use of symbolic links. On Windows, this permission is turned off by default for non-admin users. In order to run bandersnatch on Windows either call it from an elevated command prompt (i.e. right-click, run-as Administrator) or give yourself symlink permissions in the group policy editor.

#### Many sub-directories needed

The PyPI has a quite extensive list of packages that we need to maintain in a
flat directory. Filesystems with small limits on the number of sub-directories
per directory can run into a problem like this:

```console
    2013-07-09 16:11:33,331 ERROR: Error syncing package: zweb@802449
    OSError: [Errno 31] Too many links: '../pypi/web/simple/zweb'
```

Specifically we recommend to avoid using ext3. Ext4 and newer does not have the
limitation of 32k sub-directories.

#### Client Compatibility

A bandersnatch static mirror is compatible only to the "static",  cacheable
parts of PyPI that are needed to support package installation. It does not
support more dynamic APIs of PyPI that maybe be used by various clients for
other purposes.

An example of an unsupported API is [PyPI's XML-RPC interface](https://warehouse.readthedocs.io/api-reference/xml-rpc/), which is used when running `pip search`.

### Bandersnatch Mission

The bandersnatch project strives to:

- Mirror all static objects of the Python Package Index (<https://pypi.org/>)
- bandersnatch's main goal is to support the main global index to local syncing **only**
- This will allow organizations to have lower latency access to PyPI and
  save bandwidth on their WAN connections and more importantly the PyPI CDN
- Custom features and requests may be accepted if they can be of a *plugin* form
  - e.g. refer to the `blocklist` and `allowlist` plugins

### Contact

If you have questions or comments, please submit a bug report to
<https://github.com/pypa/bandersnatch/issues/new>

- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit <https://discord.com/invite/pypa>

### Code of Conduct

Everyone interacting in the bandersnatch project's codebases, issue trackers,
chat rooms, and mailing lists is expected to follow the
[PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).

### Kudos

This client is based on the original pep381client by *Martin v. Loewis*.

*Richard Jones* was very patient answering questions at PyCon 2013 and made the
protocol more reliable by implementing some PyPI enhancements.

*Christian Theune* for creating and maintaining `bandersnatch` for many years!


%prep
%autosetup -n bandersnatch-6.3.0

%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-bandersnatch -f filelist.lst
%dir %{python3_sitelib}/*

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

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 6.3.0-1
- Package Spec generated