crackerjack 0.1.11__tar.gz → 0.1.12__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of crackerjack might be problematic. Click here for more details.
- {crackerjack-0.1.11 → crackerjack-0.1.12}/PKG-INFO +23 -8
- {crackerjack-0.1.11 → crackerjack-0.1.12}/README.md +22 -7
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.pre-commit-config.yaml +2 -2
- {crackerjack-0.1.11 → crackerjack-0.1.12}/pyproject.toml +1 -1
- {crackerjack-0.1.11 → crackerjack-0.1.12}/LICENSE +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.crackerjack-config.yaml +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.gitignore +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.libcst.codemod.yaml +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.ruff_cache/.gitignore +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/.ruff_cache/CACHEDIR.TAG +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/__init__.py +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/__main__.py +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/crackerjack.py +0 -0
- {crackerjack-0.1.11 → crackerjack-0.1.12}/crackerjack/pyproject.toml +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: crackerjack
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.12
|
|
4
4
|
Summary: Crackerjack code formatting style.
|
|
5
5
|
Keywords: black ruff mypy creosote refurb
|
|
6
6
|
Home-page: https://github.com/lesleslie/crackerjack
|
|
@@ -33,10 +33,13 @@ Description-Content-Type: text/markdown
|
|
|
33
33
|
|
|
34
34
|
Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
|
|
35
35
|
|
|
36
|
+
crack·er·jack ˈkra-kər-ˌjak
|
|
37
|
+
: a person or thing of marked excellence
|
|
38
|
+
|
|
36
39
|
### **Why Crackerjack?**
|
|
37
40
|
|
|
38
|
-
Crackerjack works on the theory that with static typing and explicit
|
|
39
|
-
|
|
41
|
+
Crackerjack works on the theory that with static typing and explicit class,
|
|
42
|
+
function, variable, and other object names - the code should be
|
|
40
43
|
straight forward to read and the documentation should pretty much be able to write
|
|
41
44
|
itself. Crackerjack provides a set of guidelines and utilities to keep the codebase clean, elegant, standardized, and
|
|
42
45
|
easily readable.
|
|
@@ -57,15 +60,17 @@ This package:
|
|
|
57
60
|
|
|
58
61
|
- streamlines code with refurb
|
|
59
62
|
|
|
60
|
-
-
|
|
61
|
-
|
|
62
|
-
- installs, or updates, a projects pre-commit tools and gitignore
|
|
63
|
+
- installs, or updates, a project's pre-commit tools and gitignore
|
|
63
64
|
to comply with evolving crackerjack standards
|
|
64
65
|
|
|
65
66
|
- removes pipenv, poetry, and hatch build, dependency management, and virtual environment
|
|
66
|
-
management packages and
|
|
67
|
+
management packages and replaces them with PDM using PEP 582
|
|
68
|
+
|
|
69
|
+
- converts/creates documentation in Markdown (md) - Coming Soon!
|
|
67
70
|
|
|
68
|
-
- generates pytest mock stubs if needed
|
|
71
|
+
- runs tests and generates pytest mock stubs if needed - Coming Soon!
|
|
72
|
+
|
|
73
|
+
- bumps the project version and publishes it to PyPI
|
|
69
74
|
|
|
70
75
|
### **What are the rules?**
|
|
71
76
|
|
|
@@ -112,9 +117,19 @@ From your projects root directory:
|
|
|
112
117
|
|
|
113
118
|
Cracker jack will take care of the rest.
|
|
114
119
|
|
|
120
|
+
For a full list of options:
|
|
121
|
+
|
|
122
|
+
```python -m crackerjack -h```
|
|
123
|
+
|
|
115
124
|
When you ready to publish your project:
|
|
116
125
|
|
|
117
126
|
``python -m crackerjack -p micro``
|
|
118
127
|
|
|
119
128
|
The -p option not only publishes your project but will bump your
|
|
120
129
|
project version for you. The options are 'micro', 'minor', and 'major'.
|
|
130
|
+
|
|
131
|
+
## Acknowledgements
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
BSD-3-Clause
|
|
@@ -6,10 +6,13 @@
|
|
|
6
6
|
|
|
7
7
|
Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
|
|
8
8
|
|
|
9
|
+
crack·er·jack ˈkra-kər-ˌjak
|
|
10
|
+
: a person or thing of marked excellence
|
|
11
|
+
|
|
9
12
|
### **Why Crackerjack?**
|
|
10
13
|
|
|
11
|
-
Crackerjack works on the theory that with static typing and explicit
|
|
12
|
-
|
|
14
|
+
Crackerjack works on the theory that with static typing and explicit class,
|
|
15
|
+
function, variable, and other object names - the code should be
|
|
13
16
|
straight forward to read and the documentation should pretty much be able to write
|
|
14
17
|
itself. Crackerjack provides a set of guidelines and utilities to keep the codebase clean, elegant, standardized, and
|
|
15
18
|
easily readable.
|
|
@@ -30,15 +33,17 @@ This package:
|
|
|
30
33
|
|
|
31
34
|
- streamlines code with refurb
|
|
32
35
|
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
- installs, or updates, a projects pre-commit tools and gitignore
|
|
36
|
+
- installs, or updates, a project's pre-commit tools and gitignore
|
|
36
37
|
to comply with evolving crackerjack standards
|
|
37
38
|
|
|
38
39
|
- removes pipenv, poetry, and hatch build, dependency management, and virtual environment
|
|
39
|
-
management packages and
|
|
40
|
+
management packages and replaces them with PDM using PEP 582
|
|
41
|
+
|
|
42
|
+
- converts/creates documentation in Markdown (md) - Coming Soon!
|
|
40
43
|
|
|
41
|
-
- generates pytest mock stubs if needed
|
|
44
|
+
- runs tests and generates pytest mock stubs if needed - Coming Soon!
|
|
45
|
+
|
|
46
|
+
- bumps the project version and publishes it to PyPI
|
|
42
47
|
|
|
43
48
|
### **What are the rules?**
|
|
44
49
|
|
|
@@ -85,9 +90,19 @@ From your projects root directory:
|
|
|
85
90
|
|
|
86
91
|
Cracker jack will take care of the rest.
|
|
87
92
|
|
|
93
|
+
For a full list of options:
|
|
94
|
+
|
|
95
|
+
```python -m crackerjack -h```
|
|
96
|
+
|
|
88
97
|
When you ready to publish your project:
|
|
89
98
|
|
|
90
99
|
``python -m crackerjack -p micro``
|
|
91
100
|
|
|
92
101
|
The -p option not only publishes your project but will bump your
|
|
93
102
|
project version for you. The options are 'micro', 'minor', and 'major'.
|
|
103
|
+
|
|
104
|
+
## Acknowledgements
|
|
105
|
+
|
|
106
|
+
## License
|
|
107
|
+
|
|
108
|
+
BSD-3-Clause
|
|
@@ -18,7 +18,7 @@ repos:
|
|
|
18
18
|
- id: black
|
|
19
19
|
language_version: python3.11
|
|
20
20
|
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
|
21
|
-
rev: v0.0.
|
|
21
|
+
rev: v0.0.270
|
|
22
22
|
hooks:
|
|
23
23
|
- id: ruff
|
|
24
24
|
- repo: https://github.com/fredrikaverpil/creosote
|
|
@@ -64,7 +64,7 @@ repos:
|
|
|
64
64
|
# types: [ python ]
|
|
65
65
|
# always_run: true
|
|
66
66
|
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
|
67
|
-
rev: v0.0.
|
|
67
|
+
rev: v0.0.270
|
|
68
68
|
hooks:
|
|
69
69
|
- id: ruff
|
|
70
70
|
- repo: https://github.com/psf/black
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|