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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
|
%global _empty_manifest_terminate_build 0
Name: python-pipenv-setup
Version: 3.2.0
Release: 1
Summary: sync Pipfile/Pipfile.lock to setup.py
License: MIT
URL: https://github.com/Madoshakalaka/pipenv-setup
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/29/54/5756347bce0bd4067f884add5af48361ae56c7e17159c0b60ac1d31c52a7/pipenv-setup-3.2.0.tar.gz
BuildArch: noarch
Requires: python3-pipfile
Requires: python3-colorama
Requires: python3-packaging
Requires: python3-requirementslib
Requires: python3-vistir
Requires: python3-six
Requires: python3-chardet
Requires: python3-pyparsing
Requires: python3-typing
Requires: python3-autopep8
Requires: python3-black
Requires: python3-pytest-cov
Requires: python3-pytest-datadir
Requires: python3-pytest-xdist
Requires: python3-tox
Requires: python3-autopep8
Requires: python3-types-six
Requires: python3-pytest-mypy
Requires: python3-black
Requires: python3-pytest
Requires: python3-pre-commit
%description
# Pipenv-Setup
[](https://travis-ci.org/Madoshakalaka/pipenv-setup)
[](https://github.com/Madoshakalaka/pipenv-setup/actions/workflows/ci.yml)
[](https://pypi.python.org/pypi/pipenv-setup/)
[](https://codecov.io/gh/Madoshakalaka/pipenv-setup)
[](https://badge.fury.io/py/pipenv-setup)
[](https://pypistats.org/packages/pipenv-setup)
[](https://github.com/psf/black)
A beautiful python package development tool: sync dependencies in `Pipfile` or `Pipfile.lock` to `setup.py`.
Never need again to change dependencies manually in `setup.py`, and enjoy the same
dependency locking or semantic versioning.
Or just check whether `setup.py` and `Pipfile` are consistent and sync dependency when
necessary.
## Installation
Create a command line entry point `pipenv-setup`, and add `pipenv-setup` as a `dev`
package in `Pipfile`:
```bash
pipenv install --dev pipenv-setup
```
Additionally, starting with the
[`3.2.0`](https://github.com/Madoshakalaka/pipenv-setup/releases/tag/v3.2.0) release,
[`black`](https://github.com/psf/black) and [`autopep8`](https://github.com/hhatto/autopep8) can be
included as package extras:
```bash
pipenv install --dev "pipenv-setup[black]" # alternatively: pipenv-setup[autopep8]
```
### Note
`pipenv-setup<3.2` includes pinned versions of `black` and `autopep8` as dependencies. However, most
projects manage `black` requirements independently from `pipenv-setup`; accordingly, `black` is no
longer a requirement of `pipenv-setup` after `3.2.0` (instead, include it as an extra as shown
above).
## Features
### Beautiful pipenv flavored help
`$ pipenv-setup`

### Sync to `setup.py`
- supports assorted package configuration. You can have a pipfile as ugly as you want:
```Pipfile
[package]
requests = { extras = ['socks'] }
records = '>0.5.0'
django = { git = 'https://github.com/django/django.git', ref = '1.11.4', editable = true }
"e682b37" = {file = "https://github.com/divio/django-cms/archive/release/3.4.x.zip"}
"e1839a8" = {path = ".", editable = true}
pywinusb = { version = "*", os_name = "=='nt'", index="pypi"}
```
`pipenv-setup` will still figure things out:
```bash
$ pipenv-setup sync
package e1839a8 is local, omitted in setup.py
setup.py successfully updated
23 packages from Pipfile.lock synced to setup.py
```
And things will be where they should be:
```python
# setup.py
setup(...,
install_requires=[
"certifi==2017.7.27.1",
"chardet==3.0.4",
"pywinusb==0.4.2; os_name == 'nt'",
...,
"xlrd==1.1.0",
"xlwt==1.3.0",
],
dependency_links=[
"git+https://github.com/django/django.git@1.11.4#egg=django",
"https://github.com/divio/django-cms/archive/release/3.4.x.zip",
],
)
```
- provide `--dev` flag to sync development packages with `extras_require`:
```bash
$ pipenv-setup sync --dev
setup.py successfully updated
1 default packages from Pipfile.lock synced to setup.py
1 dev packages from Pipfile.lock synced to setup.py
```
```python
# produced setup.py
setup(...,
extras_require={"dev": ["pytest==1.1.3",]},
install_requires=["xml-subsetter==0.0.1"],
)
```
- produce beautiful [Blackened](https://github.com/psf/black) `setup.py` file
- [Template](https://github.com/pypa/sampleproject/blob/master/setup.py) generation with
filled dependencies in the absence of a setup file.
```bash
$ pipenv-setup sync
setup.py not found under current directory
Creating boilerplate setup.py...
setup.py was successfully generated
23 packages synced from Pipfile.lock to setup.py
Please edit the required fields in the generated file
```
> Note: by default, `pipenv-setup` syncs lockfile instead of pipfile
#### Sync `Pipfile` vs. `Pipfile.lock`
Provide `--pipfile` flag to sync `Pipfile` instead of `Pipfile.lock`.
`pipenv-setup`
will perform a liquid sync using semantic versioning taken from `Pipfile` (instead of
using frozen pinned versions from `Pipfile.lock`):
```bash
$ pipenv-setup sync --pipfile
setup.py was successfully updated
23 packages synced from Pipfile to setup.py
```
### Checks Only
run `$ pipenv-setup check`
- checks four items
- local package in default pipfile packages
- Package version requirements in `install_requires` in setup.py that potentially violates Pipfile
- Package version requirements in `dependency_links` in setup.py that differs from Pipfile
- Default package in pipfile missing in `install_requires` or `dependency_links` in setup.py
- exits with non-zero code when conflict found (can be used in travis-ci)
- here is a somewhat extreme example:
```bash
$ pipenv-setup check
package 'numpy' has version string: >=1.2 in setup.py, which potentially violates >=1.5 in pipfile
package 'pywinusb' has version string: ==0.4.2 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: >=0.4.2,<0.5 in setup.py, which is disjoint from >0.5.0 in pipfile
package 'django' has branch/version 1.11.5 in dependency_links, which is different than 1.11.4 listed in pipfile
package 'requests' in pipfile but not in install_requires
package 'e682b37' has a url in pipfile but not in dependency_links
(exits with 1)
```
- provide `--ignore-local` flag to allow local packages in pipfile
```bash
$ pipenv-setup check
local package found in default dependency: e1839a8.
Do you mean to make it dev dependency
(exits with 1)
```
```bash
$ pipenv-setup check --ignore-local
No version conflict or missing packages/dependencies found in setup.py!
(exits with 0)
```
- provide `--strict` flag to only pass identical version requirements
By default `pipenv-setup check` passes when the version `setup.py` specifies is
"compatible" with `Pipfile`, i.e. is a subset of it. For example, a Pipfile
specifying `django~=1.1` with `setup.py` requiring `django==1.2` is such a case.
Provide `--strict` to allow only identical requirements; _i.e._ for `Pipfile`'s
`django~=1.1`, `setup.py` must require `django>=1.1,<2.0`
Example output:
```bash
$ pipenv-setup check --strict
package 'pywinusb' has version string: ==0.4.2 in setup.py, which specifies a subset of * in pipfile
package 'django' has version string: >=0.5 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: ==0.5.2 in setup.py, which specifies a subset of >0.5.0 in pipfile
package 'requests' has version string: ==2.18.4 in setup.py, which specifies a subset of * in pipfile
(exits with 1)
```
- provide `--lockfile` flag to check `setup.py` against `Pipfile.lock` instead of `Pipfile`
By default, `pipenv-setup check` compares the dependencies from `setup.py` against
the dependencies listed in `Pipfile`. This works well for most cases, but there
are some exceptions that break this strategy, including (but not necessarily limited to):
- VCS dependencies with a mutable `ref` (e.g. - git branch name instead of a tag or commit sha)
- Because these resolve to an immutable pointer (e.g. - commit sha) in `setup.py`, the
dependency will no longer match between `setup.py` and `Pipfile`. However, `Pipfile.lock`
will contain the same resolved pointer as `setup.py`.
### Pre-commit integration
You can run `pipenv-setup` automatically using a [pre-commit](https://pre-commit.com) hook. To get
started, add this configuration to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/Madoshakalaka/pipenv-setup
rev: "3.2.0" # pick a git hash / tag to point to
hooks:
- id: pipenv-setup
```
This configuration will will execute `pipenv-setup sync --pipfile` on changes to `Pipfile`,
`Pipfile.lock`, and `setup.py`.
You can also customize the default args (`"--pipfile"`). For example, to synchronize `--dev` extras:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
args: [--dev, --pipfile]
```
If using the hook during CI (or in another environment separate from a `black` / `autopep8`
installation), you can include the appropriate auto-formatter with the hook:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
additional_dependencies: [".[black]"]
```
## Contributing
If you'd like to contribute to `pipenv-setup`, see [Contribution Guide](CONTRIBUTING.md)
%package -n python3-pipenv-setup
Summary: sync Pipfile/Pipfile.lock to setup.py
Provides: python-pipenv-setup
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-pipenv-setup
# Pipenv-Setup
[](https://travis-ci.org/Madoshakalaka/pipenv-setup)
[](https://github.com/Madoshakalaka/pipenv-setup/actions/workflows/ci.yml)
[](https://pypi.python.org/pypi/pipenv-setup/)
[](https://codecov.io/gh/Madoshakalaka/pipenv-setup)
[](https://badge.fury.io/py/pipenv-setup)
[](https://pypistats.org/packages/pipenv-setup)
[](https://github.com/psf/black)
A beautiful python package development tool: sync dependencies in `Pipfile` or `Pipfile.lock` to `setup.py`.
Never need again to change dependencies manually in `setup.py`, and enjoy the same
dependency locking or semantic versioning.
Or just check whether `setup.py` and `Pipfile` are consistent and sync dependency when
necessary.
## Installation
Create a command line entry point `pipenv-setup`, and add `pipenv-setup` as a `dev`
package in `Pipfile`:
```bash
pipenv install --dev pipenv-setup
```
Additionally, starting with the
[`3.2.0`](https://github.com/Madoshakalaka/pipenv-setup/releases/tag/v3.2.0) release,
[`black`](https://github.com/psf/black) and [`autopep8`](https://github.com/hhatto/autopep8) can be
included as package extras:
```bash
pipenv install --dev "pipenv-setup[black]" # alternatively: pipenv-setup[autopep8]
```
### Note
`pipenv-setup<3.2` includes pinned versions of `black` and `autopep8` as dependencies. However, most
projects manage `black` requirements independently from `pipenv-setup`; accordingly, `black` is no
longer a requirement of `pipenv-setup` after `3.2.0` (instead, include it as an extra as shown
above).
## Features
### Beautiful pipenv flavored help
`$ pipenv-setup`

### Sync to `setup.py`
- supports assorted package configuration. You can have a pipfile as ugly as you want:
```Pipfile
[package]
requests = { extras = ['socks'] }
records = '>0.5.0'
django = { git = 'https://github.com/django/django.git', ref = '1.11.4', editable = true }
"e682b37" = {file = "https://github.com/divio/django-cms/archive/release/3.4.x.zip"}
"e1839a8" = {path = ".", editable = true}
pywinusb = { version = "*", os_name = "=='nt'", index="pypi"}
```
`pipenv-setup` will still figure things out:
```bash
$ pipenv-setup sync
package e1839a8 is local, omitted in setup.py
setup.py successfully updated
23 packages from Pipfile.lock synced to setup.py
```
And things will be where they should be:
```python
# setup.py
setup(...,
install_requires=[
"certifi==2017.7.27.1",
"chardet==3.0.4",
"pywinusb==0.4.2; os_name == 'nt'",
...,
"xlrd==1.1.0",
"xlwt==1.3.0",
],
dependency_links=[
"git+https://github.com/django/django.git@1.11.4#egg=django",
"https://github.com/divio/django-cms/archive/release/3.4.x.zip",
],
)
```
- provide `--dev` flag to sync development packages with `extras_require`:
```bash
$ pipenv-setup sync --dev
setup.py successfully updated
1 default packages from Pipfile.lock synced to setup.py
1 dev packages from Pipfile.lock synced to setup.py
```
```python
# produced setup.py
setup(...,
extras_require={"dev": ["pytest==1.1.3",]},
install_requires=["xml-subsetter==0.0.1"],
)
```
- produce beautiful [Blackened](https://github.com/psf/black) `setup.py` file
- [Template](https://github.com/pypa/sampleproject/blob/master/setup.py) generation with
filled dependencies in the absence of a setup file.
```bash
$ pipenv-setup sync
setup.py not found under current directory
Creating boilerplate setup.py...
setup.py was successfully generated
23 packages synced from Pipfile.lock to setup.py
Please edit the required fields in the generated file
```
> Note: by default, `pipenv-setup` syncs lockfile instead of pipfile
#### Sync `Pipfile` vs. `Pipfile.lock`
Provide `--pipfile` flag to sync `Pipfile` instead of `Pipfile.lock`.
`pipenv-setup`
will perform a liquid sync using semantic versioning taken from `Pipfile` (instead of
using frozen pinned versions from `Pipfile.lock`):
```bash
$ pipenv-setup sync --pipfile
setup.py was successfully updated
23 packages synced from Pipfile to setup.py
```
### Checks Only
run `$ pipenv-setup check`
- checks four items
- local package in default pipfile packages
- Package version requirements in `install_requires` in setup.py that potentially violates Pipfile
- Package version requirements in `dependency_links` in setup.py that differs from Pipfile
- Default package in pipfile missing in `install_requires` or `dependency_links` in setup.py
- exits with non-zero code when conflict found (can be used in travis-ci)
- here is a somewhat extreme example:
```bash
$ pipenv-setup check
package 'numpy' has version string: >=1.2 in setup.py, which potentially violates >=1.5 in pipfile
package 'pywinusb' has version string: ==0.4.2 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: >=0.4.2,<0.5 in setup.py, which is disjoint from >0.5.0 in pipfile
package 'django' has branch/version 1.11.5 in dependency_links, which is different than 1.11.4 listed in pipfile
package 'requests' in pipfile but not in install_requires
package 'e682b37' has a url in pipfile but not in dependency_links
(exits with 1)
```
- provide `--ignore-local` flag to allow local packages in pipfile
```bash
$ pipenv-setup check
local package found in default dependency: e1839a8.
Do you mean to make it dev dependency
(exits with 1)
```
```bash
$ pipenv-setup check --ignore-local
No version conflict or missing packages/dependencies found in setup.py!
(exits with 0)
```
- provide `--strict` flag to only pass identical version requirements
By default `pipenv-setup check` passes when the version `setup.py` specifies is
"compatible" with `Pipfile`, i.e. is a subset of it. For example, a Pipfile
specifying `django~=1.1` with `setup.py` requiring `django==1.2` is such a case.
Provide `--strict` to allow only identical requirements; _i.e._ for `Pipfile`'s
`django~=1.1`, `setup.py` must require `django>=1.1,<2.0`
Example output:
```bash
$ pipenv-setup check --strict
package 'pywinusb' has version string: ==0.4.2 in setup.py, which specifies a subset of * in pipfile
package 'django' has version string: >=0.5 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: ==0.5.2 in setup.py, which specifies a subset of >0.5.0 in pipfile
package 'requests' has version string: ==2.18.4 in setup.py, which specifies a subset of * in pipfile
(exits with 1)
```
- provide `--lockfile` flag to check `setup.py` against `Pipfile.lock` instead of `Pipfile`
By default, `pipenv-setup check` compares the dependencies from `setup.py` against
the dependencies listed in `Pipfile`. This works well for most cases, but there
are some exceptions that break this strategy, including (but not necessarily limited to):
- VCS dependencies with a mutable `ref` (e.g. - git branch name instead of a tag or commit sha)
- Because these resolve to an immutable pointer (e.g. - commit sha) in `setup.py`, the
dependency will no longer match between `setup.py` and `Pipfile`. However, `Pipfile.lock`
will contain the same resolved pointer as `setup.py`.
### Pre-commit integration
You can run `pipenv-setup` automatically using a [pre-commit](https://pre-commit.com) hook. To get
started, add this configuration to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/Madoshakalaka/pipenv-setup
rev: "3.2.0" # pick a git hash / tag to point to
hooks:
- id: pipenv-setup
```
This configuration will will execute `pipenv-setup sync --pipfile` on changes to `Pipfile`,
`Pipfile.lock`, and `setup.py`.
You can also customize the default args (`"--pipfile"`). For example, to synchronize `--dev` extras:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
args: [--dev, --pipfile]
```
If using the hook during CI (or in another environment separate from a `black` / `autopep8`
installation), you can include the appropriate auto-formatter with the hook:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
additional_dependencies: [".[black]"]
```
## Contributing
If you'd like to contribute to `pipenv-setup`, see [Contribution Guide](CONTRIBUTING.md)
%package help
Summary: Development documents and examples for pipenv-setup
Provides: python3-pipenv-setup-doc
%description help
# Pipenv-Setup
[](https://travis-ci.org/Madoshakalaka/pipenv-setup)
[](https://github.com/Madoshakalaka/pipenv-setup/actions/workflows/ci.yml)
[](https://pypi.python.org/pypi/pipenv-setup/)
[](https://codecov.io/gh/Madoshakalaka/pipenv-setup)
[](https://badge.fury.io/py/pipenv-setup)
[](https://pypistats.org/packages/pipenv-setup)
[](https://github.com/psf/black)
A beautiful python package development tool: sync dependencies in `Pipfile` or `Pipfile.lock` to `setup.py`.
Never need again to change dependencies manually in `setup.py`, and enjoy the same
dependency locking or semantic versioning.
Or just check whether `setup.py` and `Pipfile` are consistent and sync dependency when
necessary.
## Installation
Create a command line entry point `pipenv-setup`, and add `pipenv-setup` as a `dev`
package in `Pipfile`:
```bash
pipenv install --dev pipenv-setup
```
Additionally, starting with the
[`3.2.0`](https://github.com/Madoshakalaka/pipenv-setup/releases/tag/v3.2.0) release,
[`black`](https://github.com/psf/black) and [`autopep8`](https://github.com/hhatto/autopep8) can be
included as package extras:
```bash
pipenv install --dev "pipenv-setup[black]" # alternatively: pipenv-setup[autopep8]
```
### Note
`pipenv-setup<3.2` includes pinned versions of `black` and `autopep8` as dependencies. However, most
projects manage `black` requirements independently from `pipenv-setup`; accordingly, `black` is no
longer a requirement of `pipenv-setup` after `3.2.0` (instead, include it as an extra as shown
above).
## Features
### Beautiful pipenv flavored help
`$ pipenv-setup`

### Sync to `setup.py`
- supports assorted package configuration. You can have a pipfile as ugly as you want:
```Pipfile
[package]
requests = { extras = ['socks'] }
records = '>0.5.0'
django = { git = 'https://github.com/django/django.git', ref = '1.11.4', editable = true }
"e682b37" = {file = "https://github.com/divio/django-cms/archive/release/3.4.x.zip"}
"e1839a8" = {path = ".", editable = true}
pywinusb = { version = "*", os_name = "=='nt'", index="pypi"}
```
`pipenv-setup` will still figure things out:
```bash
$ pipenv-setup sync
package e1839a8 is local, omitted in setup.py
setup.py successfully updated
23 packages from Pipfile.lock synced to setup.py
```
And things will be where they should be:
```python
# setup.py
setup(...,
install_requires=[
"certifi==2017.7.27.1",
"chardet==3.0.4",
"pywinusb==0.4.2; os_name == 'nt'",
...,
"xlrd==1.1.0",
"xlwt==1.3.0",
],
dependency_links=[
"git+https://github.com/django/django.git@1.11.4#egg=django",
"https://github.com/divio/django-cms/archive/release/3.4.x.zip",
],
)
```
- provide `--dev` flag to sync development packages with `extras_require`:
```bash
$ pipenv-setup sync --dev
setup.py successfully updated
1 default packages from Pipfile.lock synced to setup.py
1 dev packages from Pipfile.lock synced to setup.py
```
```python
# produced setup.py
setup(...,
extras_require={"dev": ["pytest==1.1.3",]},
install_requires=["xml-subsetter==0.0.1"],
)
```
- produce beautiful [Blackened](https://github.com/psf/black) `setup.py` file
- [Template](https://github.com/pypa/sampleproject/blob/master/setup.py) generation with
filled dependencies in the absence of a setup file.
```bash
$ pipenv-setup sync
setup.py not found under current directory
Creating boilerplate setup.py...
setup.py was successfully generated
23 packages synced from Pipfile.lock to setup.py
Please edit the required fields in the generated file
```
> Note: by default, `pipenv-setup` syncs lockfile instead of pipfile
#### Sync `Pipfile` vs. `Pipfile.lock`
Provide `--pipfile` flag to sync `Pipfile` instead of `Pipfile.lock`.
`pipenv-setup`
will perform a liquid sync using semantic versioning taken from `Pipfile` (instead of
using frozen pinned versions from `Pipfile.lock`):
```bash
$ pipenv-setup sync --pipfile
setup.py was successfully updated
23 packages synced from Pipfile to setup.py
```
### Checks Only
run `$ pipenv-setup check`
- checks four items
- local package in default pipfile packages
- Package version requirements in `install_requires` in setup.py that potentially violates Pipfile
- Package version requirements in `dependency_links` in setup.py that differs from Pipfile
- Default package in pipfile missing in `install_requires` or `dependency_links` in setup.py
- exits with non-zero code when conflict found (can be used in travis-ci)
- here is a somewhat extreme example:
```bash
$ pipenv-setup check
package 'numpy' has version string: >=1.2 in setup.py, which potentially violates >=1.5 in pipfile
package 'pywinusb' has version string: ==0.4.2 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: >=0.4.2,<0.5 in setup.py, which is disjoint from >0.5.0 in pipfile
package 'django' has branch/version 1.11.5 in dependency_links, which is different than 1.11.4 listed in pipfile
package 'requests' in pipfile but not in install_requires
package 'e682b37' has a url in pipfile but not in dependency_links
(exits with 1)
```
- provide `--ignore-local` flag to allow local packages in pipfile
```bash
$ pipenv-setup check
local package found in default dependency: e1839a8.
Do you mean to make it dev dependency
(exits with 1)
```
```bash
$ pipenv-setup check --ignore-local
No version conflict or missing packages/dependencies found in setup.py!
(exits with 0)
```
- provide `--strict` flag to only pass identical version requirements
By default `pipenv-setup check` passes when the version `setup.py` specifies is
"compatible" with `Pipfile`, i.e. is a subset of it. For example, a Pipfile
specifying `django~=1.1` with `setup.py` requiring `django==1.2` is such a case.
Provide `--strict` to allow only identical requirements; _i.e._ for `Pipfile`'s
`django~=1.1`, `setup.py` must require `django>=1.1,<2.0`
Example output:
```bash
$ pipenv-setup check --strict
package 'pywinusb' has version string: ==0.4.2 in setup.py, which specifies a subset of * in pipfile
package 'django' has version string: >=0.5 in setup.py, which is disjoint from ~=0.3.0 in pipfile
package 'records' has version string: ==0.5.2 in setup.py, which specifies a subset of >0.5.0 in pipfile
package 'requests' has version string: ==2.18.4 in setup.py, which specifies a subset of * in pipfile
(exits with 1)
```
- provide `--lockfile` flag to check `setup.py` against `Pipfile.lock` instead of `Pipfile`
By default, `pipenv-setup check` compares the dependencies from `setup.py` against
the dependencies listed in `Pipfile`. This works well for most cases, but there
are some exceptions that break this strategy, including (but not necessarily limited to):
- VCS dependencies with a mutable `ref` (e.g. - git branch name instead of a tag or commit sha)
- Because these resolve to an immutable pointer (e.g. - commit sha) in `setup.py`, the
dependency will no longer match between `setup.py` and `Pipfile`. However, `Pipfile.lock`
will contain the same resolved pointer as `setup.py`.
### Pre-commit integration
You can run `pipenv-setup` automatically using a [pre-commit](https://pre-commit.com) hook. To get
started, add this configuration to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/Madoshakalaka/pipenv-setup
rev: "3.2.0" # pick a git hash / tag to point to
hooks:
- id: pipenv-setup
```
This configuration will will execute `pipenv-setup sync --pipfile` on changes to `Pipfile`,
`Pipfile.lock`, and `setup.py`.
You can also customize the default args (`"--pipfile"`). For example, to synchronize `--dev` extras:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
args: [--dev, --pipfile]
```
If using the hook during CI (or in another environment separate from a `black` / `autopep8`
installation), you can include the appropriate auto-formatter with the hook:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
additional_dependencies: [".[black]"]
```
## Contributing
If you'd like to contribute to `pipenv-setup`, see [Contribution Guide](CONTRIBUTING.md)
%prep
%autosetup -n pipenv-setup-3.2.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-pipenv-setup -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 3.2.0-1
- Package Spec generated
|