<!--
=====================================
generator=datazen
version=3.1.4
hash=9f7925d85eb960826e86546d7e5531ed
=====================================
-->
# userfs ([1.1.4](https://pypi.org/project/userfs/))
[](https://pypi.org/project/userfs/)
[](https://codecov.io/github/vkottler/userfs)
*A system-bootstrapping automation and introspection tool.*
## Documentation
### Generated
* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/userfs)
(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)
* By [pydoc](https://vkottler.github.io/python/pydoc/userfs.html)
(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)
## Python Version Support
This package is tested with the following Python minor versions:
* [`python3.10`](https://docs.python.org/3.10/)
* [`python3.11`](https://docs.python.org/3.11/)
* [`python3.12`](https://docs.python.org/3.12/)
## Platform Support
This package is tested on the following platforms:
* `ubuntu-latest`
* `macos-latest`
* `windows-latest`
# Introduction
# Command-line Options
```
$ ./venv3.12/bin/ufs -h
usage: ufs [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
{build,custom,fetch,noop} ...
A system-bootstrapping automation and introspection tool.
options:
-h, --help show this help message and exit
--version show program's version number and exit
-v, --verbose set to increase logging verbosity
-q, --quiet set to reduce output
--curses whether or not to use curses.wrapper when starting
--no-uvloop whether or not to disable uvloop as event loop driver
-C DIR, --dir DIR execute from a specific directory
commands:
{build,custom,fetch,noop}
set of available commands
build attempt to build a software project from its sources
custom perform a custom interaction, sourced from external
hooks
fetch attempt to obtain some software from the internet
noop command stub (does nothing)
```
## Sub-command Options
### `build`
```
$ ./venv3.12/bin/ufs build -h
usage: ufs build [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [-d] [projects ...]
positional arguments:
projects specific projects to build, arguments in the form
'key=value' will be provided as interaction options
options:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
an optional path to the configuration directory
-a, --all interact with all configured projects
-n, --no-interact don't run package-implemented interactions
-p PATTERN, --pattern PATTERN
a pattern to use to select project specifications
filtered by name
-d, --deploy whether or not to also attempt to deploy or install
the built project assets
```
### `custom`
```
$ ./venv3.12/bin/ufs custom -h
usage: ufs custom [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [projects ...]
positional arguments:
projects specific projects to build, arguments in the form
'key=value' will be provided as interaction options
options:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
an optional path to the configuration directory
-a, --all interact with all configured projects
-n, --no-interact don't run package-implemented interactions
-p PATTERN, --pattern PATTERN
a pattern to use to select project specifications
filtered by name
```
### `fetch`
```
$ ./venv3.12/bin/ufs fetch -h
usage: ufs fetch [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [-u] [projects ...]
positional arguments:
projects specific projects to build, arguments in the form
'key=value' will be provided as interaction options
options:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
an optional path to the configuration directory
-a, --all interact with all configured projects
-n, --no-interact don't run package-implemented interactions
-p PATTERN, --pattern PATTERN
a pattern to use to select project specifications
filtered by name
-u, --update whether or not to also attempt to update project
sources
```
# Internal Dependency Graph
A coarse view of the internal structure and scale of
`userfs`'s source.
Generated using [pydeps](https://github.com/thebjorn/pydeps) (via
`mk python-deps`).
Raw data
{
"_id": null,
"home_page": "https://github.com/vkottler/userfs",
"name": "userfs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Vaughn Kottler <vaughnkottler@gmail.com>",
"keywords": null,
"author": "Vaughn Kottler",
"author_email": "Vaughn Kottler <vaughnkottler@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/66/585d46344137f38056c342fc3d896bad9bf29b7668ac92e235b649e4e794/userfs-1.1.4.tar.gz",
"platform": null,
"description": "<!--\n =====================================\n generator=datazen\n version=3.1.4\n hash=9f7925d85eb960826e86546d7e5531ed\n =====================================\n-->\n\n# userfs ([1.1.4](https://pypi.org/project/userfs/))\n\n[](https://pypi.org/project/userfs/)\n\n[](https://codecov.io/github/vkottler/userfs)\n\n\n\n*A system-bootstrapping automation and introspection tool.*\n\n## Documentation\n\n### Generated\n\n* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/userfs)\n(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)\n* By [pydoc](https://vkottler.github.io/python/pydoc/userfs.html)\n(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)\n\n## Python Version Support\n\nThis package is tested with the following Python minor versions:\n\n* [`python3.10`](https://docs.python.org/3.10/)\n* [`python3.11`](https://docs.python.org/3.11/)\n* [`python3.12`](https://docs.python.org/3.12/)\n\n## Platform Support\n\nThis package is tested on the following platforms:\n\n* `ubuntu-latest`\n* `macos-latest`\n* `windows-latest`\n\n# Introduction\n\n# Command-line Options\n\n```\n$ ./venv3.12/bin/ufs -h\n\nusage: ufs [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]\n {build,custom,fetch,noop} ...\n\nA system-bootstrapping automation and introspection tool.\n\noptions:\n -h, --help show this help message and exit\n --version show program's version number and exit\n -v, --verbose set to increase logging verbosity\n -q, --quiet set to reduce output\n --curses whether or not to use curses.wrapper when starting\n --no-uvloop whether or not to disable uvloop as event loop driver\n -C DIR, --dir DIR execute from a specific directory\n\ncommands:\n {build,custom,fetch,noop}\n set of available commands\n build attempt to build a software project from its sources\n custom perform a custom interaction, sourced from external\n hooks\n fetch attempt to obtain some software from the internet\n noop command stub (does nothing)\n\n```\n\n## Sub-command Options\n\n### `build`\n\n```\n$ ./venv3.12/bin/ufs build -h\n\nusage: ufs build [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [-d] [projects ...]\n\npositional arguments:\n projects specific projects to build, arguments in the form\n 'key=value' will be provided as interaction options\n\noptions:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n an optional path to the configuration directory\n -a, --all interact with all configured projects\n -n, --no-interact don't run package-implemented interactions\n -p PATTERN, --pattern PATTERN\n a pattern to use to select project specifications\n filtered by name\n -d, --deploy whether or not to also attempt to deploy or install\n the built project assets\n\n```\n\n### `custom`\n\n```\n$ ./venv3.12/bin/ufs custom -h\n\nusage: ufs custom [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [projects ...]\n\npositional arguments:\n projects specific projects to build, arguments in the form\n 'key=value' will be provided as interaction options\n\noptions:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n an optional path to the configuration directory\n -a, --all interact with all configured projects\n -n, --no-interact don't run package-implemented interactions\n -p PATTERN, --pattern PATTERN\n a pattern to use to select project specifications\n filtered by name\n\n```\n\n### `fetch`\n\n```\n$ ./venv3.12/bin/ufs fetch -h\n\nusage: ufs fetch [-h] [-c CONFIG] [-a] [-n] [-p PATTERN] [-u] [projects ...]\n\npositional arguments:\n projects specific projects to build, arguments in the form\n 'key=value' will be provided as interaction options\n\noptions:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n an optional path to the configuration directory\n -a, --all interact with all configured projects\n -n, --no-interact don't run package-implemented interactions\n -p PATTERN, --pattern PATTERN\n a pattern to use to select project specifications\n filtered by name\n -u, --update whether or not to also attempt to update project\n sources\n\n```\n\n# Internal Dependency Graph\n\nA coarse view of the internal structure and scale of\n`userfs`'s source.\nGenerated using [pydeps](https://github.com/thebjorn/pydeps) (via\n`mk python-deps`).\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A system-bootstrapping automation and introspection tool.",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/vkottler/userfs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "725bbbf4e3ebe55849ac8a1c71aa81353fc25465709f0d62518b8dcce42a0476",
"md5": "4320d19da8bd0cca3373dd9b17ded46e",
"sha256": "5a51fdefbb8cbea81b42754aff7c5e8f45423834fcf41f763ba0c3bce3651af1"
},
"downloads": -1,
"filename": "userfs-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4320d19da8bd0cca3373dd9b17ded46e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19983,
"upload_time": "2024-04-29T04:45:09",
"upload_time_iso_8601": "2024-04-29T04:45:09.875024Z",
"url": "https://files.pythonhosted.org/packages/72/5b/bbf4e3ebe55849ac8a1c71aa81353fc25465709f0d62518b8dcce42a0476/userfs-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d66585d46344137f38056c342fc3d896bad9bf29b7668ac92e235b649e4e794",
"md5": "4eaf6729b90808802bfd7058b3c97714",
"sha256": "e215a2839e549fe60b8a8b4a51192820df421e190087aa1c34123e9f537f7731"
},
"downloads": -1,
"filename": "userfs-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "4eaf6729b90808802bfd7058b3c97714",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15342,
"upload_time": "2024-04-29T04:45:11",
"upload_time_iso_8601": "2024-04-29T04:45:11.879474Z",
"url": "https://files.pythonhosted.org/packages/5d/66/585d46344137f38056c342fc3d896bad9bf29b7668ac92e235b649e4e794/userfs-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 04:45:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vkottler",
"github_project": "userfs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "userfs"
}
JSON
