startercheck 0.1.0__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.
@@ -0,0 +1,11 @@
1
+
2
+ ### `LICENSE`
3
+
4
+ ```text
5
+ MIT License
6
+
7
+ Copyright (c) 2026 Ali Raza
8
+
9
+ Permission is hereby granted, free of charge, to any person obtaining a copy
10
+ of this software to use, copy, modify, merge, publish, distribute, sublicense,
11
+ and/or sell copies of the software.
@@ -0,0 +1,22 @@
1
+ Metadata-Version: 2.4
2
+ Name: startercheck
3
+ Version: 0.1.0
4
+ Summary: A simple CLI tool to check if a Python project is ready for PyPI publishing
5
+ Author-email: Ali Raza <aliraza6136@gmail.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: Operating System :: OS Independent
9
+ Classifier: Topic :: Software Development :: Build Tools
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Dynamic: license-file
14
+
15
+ # StarterCheck
16
+
17
+ StarterCheck is a simple Python CLI tool that checks whether a Python project is ready for basic PyPI publishing.
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ pip install startercheck
@@ -0,0 +1,8 @@
1
+ # StarterCheck
2
+
3
+ StarterCheck is a simple Python CLI tool that checks whether a Python project is ready for basic PyPI publishing.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install startercheck
@@ -0,0 +1,25 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "startercheck"
7
+ version = "0.1.0"
8
+ description = "A simple CLI tool to check if a Python project is ready for PyPI publishing"
9
+ readme = "README.md"
10
+ requires-python = ">=3.8"
11
+ authors = [
12
+ { name = "Ali Raza", email = "aliraza6136@gmail.com" }
13
+ ]
14
+ license = { text = "MIT" }
15
+ classifiers = [
16
+ "Programming Language :: Python :: 3",
17
+ "Operating System :: OS Independent",
18
+ "Topic :: Software Development :: Build Tools"
19
+ ]
20
+
21
+ [project.scripts]
22
+ startercheck = "startercheck.main:main"
23
+
24
+ [tool.setuptools.packages.find]
25
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,3 @@
1
+ from .main import check_project
2
+
3
+ __version__ = "0.1.0"
@@ -0,0 +1,42 @@
1
+ from pathlib import Path
2
+ import sys
3
+
4
+
5
+ def check_project(path="."):
6
+ project_path = Path(path)
7
+
8
+ checks = {
9
+ "README.md found": (project_path / "README.md").exists(),
10
+ "pyproject.toml found": (project_path / "pyproject.toml").exists(),
11
+ "LICENSE found": (project_path / "LICENSE").exists(),
12
+ "tests folder found": (project_path / "tests").exists(),
13
+ "src folder found": (project_path / "src").exists(),
14
+ }
15
+
16
+ score = int((sum(checks.values()) / len(checks)) * 100)
17
+
18
+ print("\nStarterCheck Report")
19
+ print("=" * 25)
20
+ print(f"Project: {project_path.resolve()}")
21
+ print(f"Score: {score}/100\n")
22
+
23
+ for check, passed in checks.items():
24
+ icon = "OK" if passed else "MISSING"
25
+ print(f"{icon} - {check}")
26
+
27
+ print("\nRecommendation:")
28
+ if score == 100:
29
+ print("Your project looks ready for basic PyPI publishing.")
30
+ else:
31
+ print("Fix the missing items before publishing to PyPI.")
32
+
33
+ return score
34
+
35
+
36
+ def main():
37
+ folder = sys.argv[1] if len(sys.argv) > 1 else "."
38
+ check_project(folder)
39
+
40
+
41
+ if __name__ == "__main__":
42
+ main()
@@ -0,0 +1,22 @@
1
+ Metadata-Version: 2.4
2
+ Name: startercheck
3
+ Version: 0.1.0
4
+ Summary: A simple CLI tool to check if a Python project is ready for PyPI publishing
5
+ Author-email: Ali Raza <aliraza6136@gmail.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: Operating System :: OS Independent
9
+ Classifier: Topic :: Software Development :: Build Tools
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Dynamic: license-file
14
+
15
+ # StarterCheck
16
+
17
+ StarterCheck is a simple Python CLI tool that checks whether a Python project is ready for basic PyPI publishing.
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ pip install startercheck
@@ -0,0 +1,10 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/startercheck/__init__.py
5
+ src/startercheck/main.py
6
+ src/startercheck.egg-info/PKG-INFO
7
+ src/startercheck.egg-info/SOURCES.txt
8
+ src/startercheck.egg-info/dependency_links.txt
9
+ src/startercheck.egg-info/entry_points.txt
10
+ src/startercheck.egg-info/top_level.txt
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ startercheck = startercheck.main:main
@@ -0,0 +1 @@
1
+ startercheck