| Name | folder-vision JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Simple FastAPI Hello World application that works everywhere |
| upload_time | 2025-08-26 12:13:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
fastapi
web
api
demo
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# folder-vision
Simple FastAPI Hello World application that works everywhere.
## Quick Install & Run
### Option 1: pipx (Recommended)
```bash
# Install pipx if you don't have it
python3 -m pip install --user pipx
python3 -m pipx ensurepath
# Restart your terminal, then:
pipx install folder-vision
folder-vision
```
### Option 2: pip + PATH fix
```bash
pip install folder-vision
# If you get "command not found", add Python scripts to PATH:
export PATH="$(python3 -m site --user-base)/bin:$PATH"
folder-vision
```
### Option 3: Direct module execution
```bash
pip install folder-vision
python3 -m folder_vision
```
Visit <http://127.0.0.1:8000/> after any method above.
## CLI Options
```bash
folder-vision --help
folder-vision --port 9000 --reload
folder-vision --version
# Short alias also available:
fv --port 3000
```
## Cross-Platform Installation Guide
### macOS
```bash
# Using Homebrew Python (recommended)
brew install python
pipx install folder-vision
# Using system Python
python3 -m pip install --user folder-vision
export PATH="$HOME/Library/Python/$(python3 -c 'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")')/bin:$PATH"
```
### Linux (Ubuntu/Debian)
```bash
# Install Python and pip
sudo apt update && sudo apt install python3 python3-pip
python3 -m pip install --user folder-vision
export PATH="$HOME/.local/bin:$PATH"
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
```
### Windows
```powershell
# Using Python from python.org or Microsoft Store
pip install folder-vision
# If command not found, add to PATH:
# %APPDATA%\Python\Python311\Scripts (adjust Python version)
# Or use module execution:
python -m folder_vision
```
### Windows (PowerShell one-liner)
```powershell
pip install folder-vision; python -m folder_vision
```
## Troubleshooting
### "Command not found" after pip install
**Problem**: The `folder-vision` script isn't on your PATH.
**Solutions**:
1. **Use pipx** (isolates CLI tools): `pipx install folder-vision`
2. **Add scripts dir to PATH**:
```bash
# Find your scripts directory
python3 -c "import sysconfig; print(sysconfig.get_paths()['scripts'])"
# Add that directory to your PATH
```
3. **Run via module**: `python3 -m folder_vision`
### Virtual Environment Issues
If installing in a venv and the command isn't found:
```bash
source .venv/bin/activate # or .venv\Scripts\activate on Windows
pip install folder-vision
folder-vision # should work now
```
### Permission Errors
On Linux/macOS, use `--user` flag:
```bash
python3 -m pip install --user folder-vision
```
### Python Version Conflicts
Ensure Python 3.9+:
```bash
python3 --version
# If older, install newer Python or use pyenv/conda
```
## Development Setup
```bash
git clone https://github.com/folder-vision/folder-vision
cd folder-vision
python3 -m venv .venv
source .venv/bin/activate # .venv\Scripts\activate on Windows
pip install -e .[dev]
pytest
```
## Distributable Zip
To create a zip you can share:
```bash
zip -r folder-vision.zip folder_vision requirements.txt README.md
```
Recipient would unzip, create venv, install requirements, and run uvicorn as above.
### Prebuilt Zip With Virtualenv (No Pip Needed On Client)
Build (on your machine):
```bash
make dist-zip
```
This produces `dist/folder-vision.zip` containing a `.venv` directory with dependencies pre-installed. On the target machine (same OS/architecture):
```bash
unzip folder-vision.zip
cd folder-vision
source .venv/bin/activate
python -m folder_vision # or: uvicorn folder_vision.app:app
```
Note: Virtualenvs are not portable across OS types (Linux vs macOS vs Windows) and sometimes not across differing minor Python versions / architectures (arm64 vs x86_64). Use this when environments are similar.
## Packaging as Executable (Optional)
You can use `pip install pipx` then `pipx run pyinstaller` or just install pyinstaller inside venv:
```bash
pip install pyinstaller
pyinstaller -F -n folder-vision run.py
```
Executable will be in `dist/`.
On another machine (same OS + architecture):
```bash
./dist/folder-vision
```
If you need cross-platform binaries, repeat the build on each target platform.
## Publishing to PyPI
1. Update version in `pyproject.toml`.
2. Build artifacts:
```bash
python -m build
```
1. (First time) install twine: `pip install twine`.
1. Upload:
```bash
twine upload dist/*
```
1. Test install:
```bash
pip install --no-cache-dir folder-vision==<version>
folder-vision
```
For a private/internal distribution you can instead host a simple index (e.g. via an S3 static site) and use `pip install --index-url <url> folder-vision`.
Raw data
{
"_id": null,
"home_page": null,
"name": "folder-vision",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "fastapi, web, api, demo, cli",
"author": null,
"author_email": "Folder Vision Team <team@foldervision.dev>",
"download_url": "https://files.pythonhosted.org/packages/72/84/b690755fb3e867d9e96b975060c0730d2b2a1a4b7399ef2564d2879d5859/folder_vision-0.1.1.tar.gz",
"platform": null,
"description": "# folder-vision\n\nSimple FastAPI Hello World application that works everywhere.\n\n## Quick Install & Run\n\n### Option 1: pipx (Recommended)\n\n```bash\n# Install pipx if you don't have it\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n# Restart your terminal, then:\npipx install folder-vision\nfolder-vision\n```\n\n### Option 2: pip + PATH fix\n\n```bash\npip install folder-vision\n# If you get \"command not found\", add Python scripts to PATH:\nexport PATH=\"$(python3 -m site --user-base)/bin:$PATH\"\nfolder-vision\n```\n\n### Option 3: Direct module execution\n\n```bash\npip install folder-vision\npython3 -m folder_vision\n```\n\nVisit <http://127.0.0.1:8000/> after any method above.\n\n## CLI Options\n\n```bash\nfolder-vision --help\nfolder-vision --port 9000 --reload\nfolder-vision --version\n# Short alias also available:\nfv --port 3000\n```\n\n## Cross-Platform Installation Guide\n\n### macOS\n\n```bash\n# Using Homebrew Python (recommended)\nbrew install python\npipx install folder-vision\n\n# Using system Python \npython3 -m pip install --user folder-vision\nexport PATH=\"$HOME/Library/Python/$(python3 -c 'import sys; print(f\"{sys.version_info.major}.{sys.version_info.minor}\")')/bin:$PATH\"\n```\n\n### Linux (Ubuntu/Debian)\n\n```bash\n# Install Python and pip\nsudo apt update && sudo apt install python3 python3-pip\npython3 -m pip install --user folder-vision\nexport PATH=\"$HOME/.local/bin:$PATH\"\necho 'export PATH=\"$HOME/.local/bin:$PATH\"' >> ~/.bashrc\n```\n\n### Windows\n\n```powershell\n# Using Python from python.org or Microsoft Store\npip install folder-vision\n# If command not found, add to PATH:\n# %APPDATA%\\Python\\Python311\\Scripts (adjust Python version)\n\n# Or use module execution:\npython -m folder_vision\n```\n\n### Windows (PowerShell one-liner)\n\n```powershell\npip install folder-vision; python -m folder_vision\n```\n\n## Troubleshooting\n\n### \"Command not found\" after pip install\n\n**Problem**: The `folder-vision` script isn't on your PATH.\n\n**Solutions**:\n\n1. **Use pipx** (isolates CLI tools): `pipx install folder-vision`\n2. **Add scripts dir to PATH**:\n\n ```bash\n # Find your scripts directory\n python3 -c \"import sysconfig; print(sysconfig.get_paths()['scripts'])\"\n # Add that directory to your PATH\n ```\n\n3. **Run via module**: `python3 -m folder_vision`\n\n### Virtual Environment Issues\n\nIf installing in a venv and the command isn't found:\n\n```bash\nsource .venv/bin/activate # or .venv\\Scripts\\activate on Windows\npip install folder-vision\nfolder-vision # should work now\n```\n\n### Permission Errors\n\nOn Linux/macOS, use `--user` flag:\n\n```bash\npython3 -m pip install --user folder-vision\n```\n\n### Python Version Conflicts\n\nEnsure Python 3.9+:\n\n```bash\npython3 --version\n# If older, install newer Python or use pyenv/conda\n```\n\n## Development Setup\n\n```bash\ngit clone https://github.com/folder-vision/folder-vision\ncd folder-vision\npython3 -m venv .venv\nsource .venv/bin/activate # .venv\\Scripts\\activate on Windows\npip install -e .[dev]\npytest\n```\n\n## Distributable Zip\n\nTo create a zip you can share:\n\n```bash\nzip -r folder-vision.zip folder_vision requirements.txt README.md\n```\n\nRecipient would unzip, create venv, install requirements, and run uvicorn as above.\n\n### Prebuilt Zip With Virtualenv (No Pip Needed On Client)\n\nBuild (on your machine):\n\n```bash\nmake dist-zip\n```\n\nThis produces `dist/folder-vision.zip` containing a `.venv` directory with dependencies pre-installed. On the target machine (same OS/architecture):\n\n```bash\nunzip folder-vision.zip\ncd folder-vision\nsource .venv/bin/activate\npython -m folder_vision # or: uvicorn folder_vision.app:app\n```\n\nNote: Virtualenvs are not portable across OS types (Linux vs macOS vs Windows) and sometimes not across differing minor Python versions / architectures (arm64 vs x86_64). Use this when environments are similar.\n\n## Packaging as Executable (Optional)\n\nYou can use `pip install pipx` then `pipx run pyinstaller` or just install pyinstaller inside venv:\n\n```bash\npip install pyinstaller\npyinstaller -F -n folder-vision run.py\n```\n\nExecutable will be in `dist/`.\n\nOn another machine (same OS + architecture):\n\n```bash\n./dist/folder-vision\n```\n\nIf you need cross-platform binaries, repeat the build on each target platform.\n\n## Publishing to PyPI\n\n1. Update version in `pyproject.toml`.\n2. Build artifacts:\n\n```bash\npython -m build\n```\n\n1. (First time) install twine: `pip install twine`.\n1. Upload:\n\n```bash\ntwine upload dist/*\n```\n\n1. Test install:\n\n```bash\npip install --no-cache-dir folder-vision==<version>\nfolder-vision\n```\n\nFor a private/internal distribution you can instead host a simple index (e.g. via an S3 static site) and use `pip install --index-url <url> folder-vision`.\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple FastAPI Hello World application that works everywhere",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://github.com/folder-vision/folder-vision#readme",
"Homepage": "https://github.com/folder-vision/folder-vision",
"Issues": "https://github.com/folder-vision/folder-vision/issues",
"Repository": "https://github.com/folder-vision/folder-vision"
},
"split_keywords": [
"fastapi",
" web",
" api",
" demo",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "422d8c39e0eca05bc2485cbfdd65ebc61ceb9e4495dde573928bb2ac71f6c06c",
"md5": "1eddfd6343de40eba384571834922f05",
"sha256": "7679663ad46cf40d5657ef134cd5deb73bdd6d262e88bf60e4e44e31b0396a1c"
},
"downloads": -1,
"filename": "folder_vision-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1eddfd6343de40eba384571834922f05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6285,
"upload_time": "2025-08-26T12:13:49",
"upload_time_iso_8601": "2025-08-26T12:13:49.069918Z",
"url": "https://files.pythonhosted.org/packages/42/2d/8c39e0eca05bc2485cbfdd65ebc61ceb9e4495dde573928bb2ac71f6c06c/folder_vision-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7284b690755fb3e867d9e96b975060c0730d2b2a1a4b7399ef2564d2879d5859",
"md5": "a77a8ef7813a6bb2feca6389e0b2d0e5",
"sha256": "761e60f0466f3afdc6638837b75a47196809a202d24b4c0add815f1332d67a6a"
},
"downloads": -1,
"filename": "folder_vision-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a77a8ef7813a6bb2feca6389e0b2d0e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5806,
"upload_time": "2025-08-26T12:13:50",
"upload_time_iso_8601": "2025-08-26T12:13:50.372094Z",
"url": "https://files.pythonhosted.org/packages/72/84/b690755fb3e867d9e96b975060c0730d2b2a1a4b7399ef2564d2879d5859/folder_vision-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 12:13:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "folder-vision",
"github_project": "folder-vision#readme",
"github_not_found": true,
"lcname": "folder-vision"
}
