| Name | hostess JSON |
| Version |
0.10.1
JSON |
| download |
| home_page | None |
| Summary | intuitive admin library |
| upload_time | 2024-08-20 19:39:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hostess
## overview
`hostess` provides lightweight, Pythonic interfaces to distributed resources,
system processes, and Python internals. It includes high-level modules that
provide special functionality for working with EC2 instances and S3 buckets,
and a framework (`station`) for workflow coordination -- along with all their
lower-level building blocks.
`hostess` reduces syntactic headaches and boilerplate while still
allowing low-level manipulation and, more broadly, still feeling like code.
`hostess` has a special emphasis on fitting intuitively and idiomatically into
common data science and scientific analysis workflows, but it is fundamentally
a general-purpose utility and administration library.
## installation
`hostess` is available on PyPI and conda-forge. We recommend installing it
into a Conda environment using `conda`:
`conda install -n my_environment -c conda-forge hostess`.
The conda-forge package installs all optional dependencies other than those
for tests and Notebooks. If you require more granular control over
dependencies, please install from source.
## documentation
Examples for working with EC2 instances can be found [in this jupyter notebook](https://github.com/MillionConcepts/hostess/blob/main/examples/ec2.ipynb).
Examples for working with S3 buckets can be found [in this jupyter notebook](https://github.com/MillionConcepts/hostess/blob/main/examples/s3.ipynb).
[You can find an API reference and full changelog on readthedocs.](https://hostess.readthedocs.io)
[](https://hostess.readthedocs.io/en/latest/?badge=latest)
## compatibility
1. `hostess`'s core features are closely linked to the shell, so it is
only fully compatible with Unix-scented operating systems. Linux and MacOS
count, as does Windows Subsystem for Linux (WSL). Windows *outside* of WSL
doesn't.
2. Some `hostess` modules require network access, specifically `ssh` and the
`aws` submodules. The `aws` submodules also require an AWS account. See the
example Notebooks for more details on this.
3. `hostess` requires Python >= 3.9.
4. `hostess` is very lightweight. If a machine has enough resources to run
a Python interpreter, it can probably run `hostess`.
5. `hostess.station` is not fully compatible with MacOS or WSL. MacOS and WSL
compatibility is planned. All other parts of `hostess` are compatible with
MacOS and WSL.
## cautions
`hostess` is a reliable and fairly feature-complete beta in active use on
multiple projects. However, we do not yet guarantee interface stability or
backwards compatibility.
Also, as with _any_ system administration software, we recommend using it very
carefully.
## tests
`hostess` includes a simple test suite compatible with `pytest`. More
comprehensive tests are planned. (In particular, non-local networking features
currently lack test coverage.) You can run the tests by executing `pytest -s`
in the root directory. The `-s` flag is mandatory because `pytest` captures
stdout by default, which breaks some `hostess` features covered by the tests.
Tests require two additional dependencies: `pytest` and `pillow`.
## licensing
You can do almost anything with this software that you like, subject only to
the extremely permissive terms of the [BSD 3-Clause License](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "hostess",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "\"M. St. Clair\" <mstclair@millionconcepts.com>, Sierra Brown <sierra@millionconcepts.com>, Chase Million <chase@millionconcepts.com>",
"download_url": "https://files.pythonhosted.org/packages/f9/8d/ddf92811e1c6551c8da2d306086fbc66736bb8c20627bad137f83f8cce2d/hostess-0.10.1.tar.gz",
"platform": null,
"description": "# hostess\n\n## overview\n\n`hostess` provides lightweight, Pythonic interfaces to distributed resources, \nsystem processes, and Python internals. It includes high-level modules that \nprovide special functionality for working with EC2 instances and S3 buckets,\nand a framework (`station`) for workflow coordination -- along with all their \nlower-level building blocks.\n\n`hostess` reduces syntactic headaches and boilerplate while still \nallowing low-level manipulation and, more broadly, still feeling like code. \n`hostess` has a special emphasis on fitting intuitively and idiomatically into \ncommon data science and scientific analysis workflows, but it is fundamentally \na general-purpose utility and administration library.\n\n## installation\n\n`hostess` is available on PyPI and conda-forge. We recommend installing it\ninto a Conda environment using `conda`:\n`conda install -n my_environment -c conda-forge hostess`. \n\nThe conda-forge package installs all optional dependencies other than those\nfor tests and Notebooks. If you require more granular control over \ndependencies, please install from source.\n\n## documentation\n\nExamples for working with EC2 instances can be found [in this jupyter notebook](https://github.com/MillionConcepts/hostess/blob/main/examples/ec2.ipynb).\n\nExamples for working with S3 buckets can be found [in this jupyter notebook](https://github.com/MillionConcepts/hostess/blob/main/examples/s3.ipynb).\n\n[You can find an API reference and full changelog on readthedocs.](https://hostess.readthedocs.io)\n[](https://hostess.readthedocs.io/en/latest/?badge=latest)\n\n## compatibility\n\n1. `hostess`'s core features are closely linked to the shell, so it is \nonly fully compatible with Unix-scented operating systems. Linux and MacOS \ncount, as does Windows Subsystem for Linux (WSL). Windows *outside* of WSL \ndoesn't.\n2. Some `hostess` modules require network access, specifically `ssh` and the\n`aws` submodules. The `aws` submodules also require an AWS account. See the \nexample Notebooks for more details on this.\n3. `hostess` requires Python >= 3.9.\n4. `hostess` is very lightweight. If a machine has enough resources to run \na Python interpreter, it can probably run `hostess`.\n5. `hostess.station` is not fully compatible with MacOS or WSL. MacOS and WSL \ncompatibility is planned. All other parts of `hostess` are compatible with \nMacOS and WSL.\n\n## cautions\n\n`hostess` is a reliable and fairly feature-complete beta in active use on\nmultiple projects. However, we do not yet guarantee interface stability or\nbackwards compatibility. \n\nAlso, as with _any_ system administration software, we recommend using it very \ncarefully.\n\n## tests\n\n`hostess` includes a simple test suite compatible with `pytest`. More \ncomprehensive tests are planned. (In particular, non-local networking features \ncurrently lack test coverage.) You can run the tests by executing `pytest -s` \nin the root directory. The `-s` flag is mandatory because `pytest` captures\nstdout by default, which breaks some `hostess` features covered by the tests.\n\nTests require two additional dependencies: `pytest` and `pillow`.\n\n## licensing\n\nYou can do almost anything with this software that you like, subject only to \nthe extremely permissive terms of the [BSD 3-Clause License](LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "intuitive admin library",
"version": "0.10.1",
"project_urls": {
"Changelog": "https://hostess.readthedocs.io/en/latest/version_history/",
"Documentation": "https://hostess.readthedocs.io/en/latest/",
"Repository": "https://github.com/MillionConcepts/hostess"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a39b913ed2fadf7a59e629810e3c6717dd63936412b51dfa70537e25c64f3f3b",
"md5": "d5613db684aeeb51d95e6c4eec816532",
"sha256": "e59f776b42e3afa1e6d14782fc624305eb71883af306093a7e9489dcb449e2f7"
},
"downloads": -1,
"filename": "hostess-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5613db684aeeb51d95e6c4eec816532",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 371712,
"upload_time": "2024-08-20T19:39:12",
"upload_time_iso_8601": "2024-08-20T19:39:12.245405Z",
"url": "https://files.pythonhosted.org/packages/a3/9b/913ed2fadf7a59e629810e3c6717dd63936412b51dfa70537e25c64f3f3b/hostess-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f98dddf92811e1c6551c8da2d306086fbc66736bb8c20627bad137f83f8cce2d",
"md5": "8c232c5bf22b44ec92b7755737ff8b31",
"sha256": "71fe7f03972b4ae260d7d37a79be7b2c25d56e290bc4a92a2d0636b85b144fe1"
},
"downloads": -1,
"filename": "hostess-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "8c232c5bf22b44ec92b7755737ff8b31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 371780,
"upload_time": "2024-08-20T19:39:14",
"upload_time_iso_8601": "2024-08-20T19:39:14.209377Z",
"url": "https://files.pythonhosted.org/packages/f9/8d/ddf92811e1c6551c8da2d306086fbc66736bb8c20627bad137f83f8cce2d/hostess-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 19:39:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MillionConcepts",
"github_project": "hostess",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hostess"
}
