| Name | fire-prox JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Fast prototyping for FireStore |
| upload_time | 2025-10-12 23:09:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License
Copyright (c) 2025 Nehal Patel
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
firebase
firestore
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Fire-Prox
[](https://github.com/habemus-papadum/fire-prox/actions/workflows/ci.yml)
[](https://htmlpreview.github.io/?https://github.com/habemus-papadum/fire-prox/blob/python-coverage-comment-action-data/htmlcov/index.html)
[](https://habemus-papadum.github.io/fire-prox/)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/astral-sh/ruff)
## Setup
Before running tests or using the project, make sure to install all dependencies:
```bash
# Install Python dependencies
uv sync --frozen
# Install Node.js dependencies (for Firebase tools)
pnpm install
```
## Testing
The project includes a flexible test runner that makes it easy to pass additional parameters to pytest while running Firebase emulators. The test runner launches a local Firestore emulator that Python code is configured to interact with by default and then tears down the emulator once the unit tests are done.
### VSCode & Demo Notebooks
For running test in vscode or using the demo notebooks, you need to launch the developer emulator using `pnpm developer-emulator`.
### Running Tests
You can run tests in several ways:
```bash
# Using the bash script directly
./test.sh
# Using npm/pnpm (calls the bash script)
pnpm test
# With additional pytest parameters
./test.sh -v # Verbose output
./test.sh -k test_specific # Run specific test
./test.sh --tb=short # Short traceback format
./test.sh -v -k test_fire_prox # Combine multiple options
```
The test script automatically starts Firebase emulators and runs your tests within that environment, then cleans up afterward.
### Firestore Test Harness
Tests can rely on the `firestore_test_harness` pytest fixture (published in `fire_prox.testing`) to ensure the emulator database is fully deleted both before a test starts and after it finishes. The harness can also be used as a context manager when writing ad-hoc scripts:
```python
from google.cloud import firestore
from fire_prox.testing import firestore_harness
with firestore_harness() as harness:
client = firestore.Client(project=harness.project_id)
# interact with Firestore here
```
Raw data
{
"_id": null,
"home_page": null,
"name": "fire-prox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "firebase, firestore",
"author": null,
"author_email": "Nehal Patel <nehal@alum.mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/1c/4f/6f666412c8cc69bdff5ce45b4c2ca4e1d6cedf68381168393b1824e29959/fire_prox-0.3.0.tar.gz",
"platform": null,
"description": "# Fire-Prox\n\n[](https://github.com/habemus-papadum/fire-prox/actions/workflows/ci.yml)\n[](https://htmlpreview.github.io/?https://github.com/habemus-papadum/fire-prox/blob/python-coverage-comment-action-data/htmlcov/index.html)\n[](https://habemus-papadum.github.io/fire-prox/)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/astral-sh/ruff)\n\n## Setup\n\nBefore running tests or using the project, make sure to install all dependencies:\n\n```bash\n# Install Python dependencies\nuv sync --frozen\n\n# Install Node.js dependencies (for Firebase tools)\npnpm install\n```\n\n## Testing\n\nThe project includes a flexible test runner that makes it easy to pass additional parameters to pytest while running Firebase emulators. The test runner launches a local Firestore emulator that Python code is configured to interact with by default and then tears down the emulator once the unit tests are done.\n\n### VSCode & Demo Notebooks\nFor running test in vscode or using the demo notebooks, you need to launch the developer emulator using `pnpm developer-emulator`. \n\n### Running Tests\n\nYou can run tests in several ways:\n\n```bash\n# Using the bash script directly\n./test.sh\n\n# Using npm/pnpm (calls the bash script)\npnpm test\n\n# With additional pytest parameters\n./test.sh -v # Verbose output\n./test.sh -k test_specific # Run specific test\n./test.sh --tb=short # Short traceback format\n./test.sh -v -k test_fire_prox # Combine multiple options\n```\n\nThe test script automatically starts Firebase emulators and runs your tests within that environment, then cleans up afterward.\n\n### Firestore Test Harness\n\nTests can rely on the `firestore_test_harness` pytest fixture (published in `fire_prox.testing`) to ensure the emulator database is fully deleted both before a test starts and after it finishes. The harness can also be used as a context manager when writing ad-hoc scripts:\n\n```python\nfrom google.cloud import firestore\nfrom fire_prox.testing import firestore_harness\n\nwith firestore_harness() as harness:\n client = firestore.Client(project=harness.project_id)\n # interact with Firestore here\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Nehal Patel\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Fast prototyping for FireStore",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://github.com/habemus-papadum/fire-prox",
"Homepage": "https://github.com/habemus-papadum/fire-prox",
"Repository": "https://github.com/habemus-papadum/fire-prox"
},
"split_keywords": [
"firebase",
" firestore"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a24cfff6b96221999c419bb177ec07be9d5a7e81e3de8b57fd0d54c266b57209",
"md5": "1c0e34a738547d5080352c91d23cfef2",
"sha256": "12e21ffb298d044a76cadbfefdfb3401ebee55c6b82c51ab76f4a623812978eb"
},
"downloads": -1,
"filename": "fire_prox-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c0e34a738547d5080352c91d23cfef2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 55954,
"upload_time": "2025-10-12T23:09:58",
"upload_time_iso_8601": "2025-10-12T23:09:58.033736Z",
"url": "https://files.pythonhosted.org/packages/a2/4c/fff6b96221999c419bb177ec07be9d5a7e81e3de8b57fd0d54c266b57209/fire_prox-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1c4f6f666412c8cc69bdff5ce45b4c2ca4e1d6cedf68381168393b1824e29959",
"md5": "fd05ff1e491413bec32aa1007993ca82",
"sha256": "dd54247e5522701e79b6dccba8924f0c85db9bd9ec3fc137ece0199a1f8d72e8"
},
"downloads": -1,
"filename": "fire_prox-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "fd05ff1e491413bec32aa1007993ca82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 679465,
"upload_time": "2025-10-12T23:09:59",
"upload_time_iso_8601": "2025-10-12T23:09:59.426414Z",
"url": "https://files.pythonhosted.org/packages/1c/4f/6f666412c8cc69bdff5ce45b4c2ca4e1d6cedf68381168393b1824e29959/fire_prox-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-12 23:09:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "habemus-papadum",
"github_project": "fire-prox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fire-prox"
}
