[main]: update README

Author: recursivezero

.pipyrc

@@ -61,6 +61,7 @@ projectx
 pycache
 pyenv
 pyflakes
+pypirc
 pypoetry
 pyproject
 pytest
@@ -85,6 +86,7 @@ stefanzweifel
 streamlit
 Succesfully
 sucess
+testpy
 tobytes
 torchvision
 txtl

.vscode/dictionaries/project-words.txt

@@ -1,6 +1,6 @@
-# Fabric Generator and Search Utility
+# Sample-py
 
-A Streamlit template for Recursive Zero repository
+A streamlit, fast api boilerplate for python development
 
 ## Installation Guide
 
@@ -12,9 +12,9 @@ A Streamlit template for Recursive Zero repository
 
 ## Getting Started
 
-- [Unix/macOS Setup Guide](./docs/setup-for-osx.md)
+- [Unix/macOS Setup Guide][unix-setup]
 
-- [Windows Setup Guide](./docs/setup-for-windows.md)
+- [Windows Setup Guide][windows-setup]
 
 ## Poetry Setup
 
@@ -177,10 +177,12 @@ poetry env remove <environment-full-name>
 
 ## References
 
+[unix-setup]: (https://github.com/recursivezero/python/wiki/setup-for-osx)
+[windows-setup]: (https://github.com/recursivezero/python/wiki/setup-for-windows)
+
 - [Python Downloads](https://www.python.org/downloads)
 - [Virtualenv Docs](https://docs.python.org/3/library/venv.html)
-- [Python Tips](https://www.airplane.dev/blog/12-useful-python-scripts-for-developers)
 - [Poetry Docs](https://python-poetry.org/docs/)
 - [MyPy Docs](https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports)
-- [Useful Poetry commands](./docs//POETRY_COMMANDS.md)nning_mypy.html#missing-imports)
-- [Useful Poetry commands](./docs//POETRY_COMMANDS.md)
+- [Useful Poetry commands](https://github.com/recursivezero/python/wiki/POETRY_COMMANDS.md)
+- [Useful Poetry commands](https://github.com/recursivezero/python/wiki/POETRY_COMMANDS.md)

README.md

@@ -0,0 +1,59 @@
+# Publish the package on testpy
+
+1. Register the Repository
+
+Poetry needs to know the specific upload URL for TestPyPI. Use the legacy upload endpoint
+
+```bash
+poetry config repositories.<project-name> https://test.pypi.org/legacy/
+```
+
+1. Disable System Keyring (Optional but Recommended)
+   If you encounter 403 Forbidden errors or the terminal hangs, disable the system keyring to force Poetry to use a local auth.toml file for your tokens
+
+```bash
+poetry config keyring.enabled false
+```
+
+3. Set Your API Token
+   Add your TestPyPI API token. Ensure it includes the _pypi-_ prefix.
+
+```bash
+poetry config pypi-token.<project-name> pypi-your-token-here
+```
+
+1. Rename Project (If Needed)
+
+If you need to change the package name to avoid conflicts on TestPyPI, update the name field in your pyproject.toml. After renaming, refresh your environment:
+
+## Update the 'name' field in pyproject.toml first, then
+
+```bash
+poetry install
+```
+
+5. Build and Publish
+   You can build and publish the package in a single command. The -r flag specifies the repository we configured in step 1.
+
+```bash
+poetry publish -r <project-name> --build
+```
+
+6. Update and republish
+   1. change version using `poetry version major` other value is _minor_ or _patch_, use as per requirements.
+   2. sync and rebuild
+
+   ```bash
+   poetry lock
+   poetry build
+   ```
+
+   3. `poetry publish -r <project-name>`
+
+---
+
+## Quick Checklist before Publishing
+
+- Unique Name: Ensure the name in pyproject.toml isn't already taken on [TestPyPI](https://test.pypi.org/).
+- Version Bump: If you are re-uploading, you must increment the version in pyproject.toml.
+- Trailing Slash: Ensure your repository URL ends with /legacy/ to avoid 405 or 400 errors.

docs/PUBLISH.md

@@ -1,6 +1,6 @@
 [project]
-name = "sample"
-version = "1.1.0"
+name = "rz-sample"
+version = "1.2.0"
 description = "A python template for fastapi and streamlit projects."
 authors = [{ name = "sample", email = "recursivezero@outlook.com" }]
 license = "MIT"

pyproject.toml

@@ -40,8 +40,8 @@
     "window.autoDetectColorScheme": true,
     "explorer.fileNesting.enabled": true,
     "explorer.fileNesting.patterns": {
-      "pyproject.toml": "poetry.lock,ruff.toml, mypy.ini",
-      ".gitignore": ".gitattributes, .pip*, .poetryignore, .editorconfig, .eslint*, .npm*, .markdown*, .flake8, .env*",
+      "pyproject.toml": "poetry.lock,ruff.toml, mypy.ini, .pip-audit.toml",
+      ".gitignore": ".gitattributes, .pypirc, .poetryignore, .editorconfig, .eslint*, .npm*, .markdown*, .flake8, .env*",
       "README.md": "*.md, requirements.txt,packages.txt",
       "LICENSE": "LICENSE-*"
     },