[](https://pyscaffold.org/)
<!-- These are examples of badges you might also want to add to your README. Update the URLs accordingly.
[](https://cirrus-ci.com/github/<USER>/evafs)
[](https://evafs.readthedocs.io/en/stable/)
[](https://coveralls.io/r/<USER>/evafs)
[](https://pypi.org/project/evafs/)
[](https://anaconda.org/conda-forge/evafs)
[](https://pepy.tech/project/evafs)
[](https://twitter.com/evafs)
-->
# evafs
> A storage system middleware
A longer description of your project goes here...
## Installation
In order to set up the necessary environment:
1. review and uncomment what you need in `environment.yml` and create an environment `evafs` with the help of [conda]:
```
conda env create -f environment.yml
```
2. activate the new environment with:
```
conda activate evafs
```
> **_NOTE:_** The conda environment will have evafs installed in editable mode.
> Some changes, e.g. in `setup.cfg`, might require you to run `pip install -e .` again.
Optional and needed only once after `git clone`:
3. install several [pre-commit] git hooks with:
```bash
pre-commit install
# You might also want to run `pre-commit autoupdate`
```
and checkout the configuration under `.pre-commit-config.yaml`.
The `-n, --no-verify` flag of `git commit` can be used to deactivate pre-commit hooks temporarily.
4. install [nbstripout] git hooks to remove the output cells of committed notebooks with:
```bash
nbstripout --install --attributes notebooks/.gitattributes
```
This is useful to avoid large diffs due to plots in your notebooks.
A simple `nbstripout --uninstall` will revert these changes.
Then take a look into the `scripts` and `notebooks` folders.
## Dependency Management & Reproducibility
1. Always keep your abstract (unpinned) dependencies updated in `environment.yml` and eventually
in `setup.cfg` if you want to ship and install your package via `pip` later on.
2. Create concrete dependencies as `environment.lock.yml` for the exact reproduction of your
environment with:
```bash
conda env export -n evafs -f environment.lock.yml
```
For multi-OS development, consider using `--no-builds` during the export.
3. Update your current environment with respect to a new `environment.lock.yml` using:
```bash
conda env update -f environment.lock.yml --prune
```
## Project Organization
```
├── AUTHORS.md <- List of developers and maintainers.
├── CHANGELOG.md <- Changelog to keep track of new features and fixes.
├── CONTRIBUTING.md <- Guidelines for contributing to this project.
├── Dockerfile <- Build a docker container with `docker build .`.
├── LICENSE.txt <- License as chosen on the command-line.
├── README.md <- The top-level README for developers.
├── configs <- Directory for configurations of model & application.
├── data
│ ├── external <- Data from third party sources.
│ ├── interim <- Intermediate data that has been transformed.
│ ├── processed <- The final, canonical data sets for modeling.
│ └── raw <- The original, immutable data dump.
├── docs <- Directory for Sphinx documentation in rst or md.
├── environment.yml <- The conda environment file for reproducibility.
├── models <- Trained and serialized models, model predictions,
│ or model summaries.
├── notebooks <- Jupyter notebooks. Naming convention is a number (for
│ ordering), the creator's initials and a description,
│ e.g. `1.0-fw-initial-data-exploration`.
├── pyproject.toml <- Build configuration. Don't change! Use `pip install -e .`
│ to install for development or to build `tox -e build`.
├── references <- Data dictionaries, manuals, and all other materials.
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated plots and figures for reports.
├── scripts <- Analysis and production scripts which import the
│ actual PYTHON_PKG, e.g. train_model.
├── setup.cfg <- Declarative configuration of your project.
├── setup.py <- [DEPRECATED] Use `python setup.py develop` to install for
│ development or `python setup.py bdist_wheel` to build.
├── src
│ └── evafs <- Actual Python package where the main functionality goes.
├── tests <- Unit tests which can be run with `pytest`.
├── .coveragerc <- Configuration for coverage reports of unit tests.
├── .isort.cfg <- Configuration for git hook that sorts imports.
└── .pre-commit-config.yaml <- Configuration of pre-commit git hooks.
```
## Contribution
EvaFS employs [Tox](https://tox.wiki/en/stable/) to automate Package tasks such as packaging, testing and building.
```bash
tox -e docs # to build your documentation
tox -e build # to build your package distribution
tox -e publish # to test your project uploads correctly in test.pypi.org
tox -e publish -- --repository pypi # to release your package to PyPI
tox -av # to list all the tasks available
```
<!-- pyscaffold-notes -->
## Note
This project has been set up using [PyScaffold] 4.5 and the [dsproject extension] 0.0.post163+g5845251.
[conda]: https://docs.conda.io/
[pre-commit]: https://pre-commit.com/
[Jupyter]: https://jupyter.org/
[nbstripout]: https://github.com/kynan/nbstripout
[Google style]: http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[PyScaffold]: https://pyscaffold.org/
[dsproject extension]: https://github.com/pyscaffold/pyscaffoldext-dsproject
Raw data
{
"_id": null,
"home_page": "https://github.com/pyscaffold/pyscaffold/",
"name": "evafs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "sanchezcarlosjr",
"author_email": "24639141+sanchezcarlosjr@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/d5/03/18f806431cddf2767385c9eb36d63e7e163adf9905835b09e1adf1c0f2ee/evafs-0.0.11.tar.gz",
"platform": "any",
"description": "[](https://pyscaffold.org/)\n<!-- These are examples of badges you might also want to add to your README. Update the URLs accordingly.\n[](https://cirrus-ci.com/github/<USER>/evafs)\n[](https://evafs.readthedocs.io/en/stable/)\n[](https://coveralls.io/r/<USER>/evafs)\n[](https://pypi.org/project/evafs/)\n[](https://anaconda.org/conda-forge/evafs)\n[](https://pepy.tech/project/evafs)\n[](https://twitter.com/evafs)\n-->\n\n# evafs\n\n> A storage system middleware\n\nA longer description of your project goes here...\n\n## Installation\n\nIn order to set up the necessary environment:\n\n1. review and uncomment what you need in `environment.yml` and create an environment `evafs` with the help of [conda]:\n ```\n conda env create -f environment.yml\n ```\n2. activate the new environment with:\n ```\n conda activate evafs\n ```\n\n> **_NOTE:_** The conda environment will have evafs installed in editable mode.\n> Some changes, e.g. in `setup.cfg`, might require you to run `pip install -e .` again.\n\n\nOptional and needed only once after `git clone`:\n\n3. install several [pre-commit] git hooks with:\n ```bash\n pre-commit install\n # You might also want to run `pre-commit autoupdate`\n ```\n and checkout the configuration under `.pre-commit-config.yaml`.\n The `-n, --no-verify` flag of `git commit` can be used to deactivate pre-commit hooks temporarily.\n\n4. install [nbstripout] git hooks to remove the output cells of committed notebooks with:\n ```bash\n nbstripout --install --attributes notebooks/.gitattributes\n ```\n This is useful to avoid large diffs due to plots in your notebooks.\n A simple `nbstripout --uninstall` will revert these changes.\n\n\nThen take a look into the `scripts` and `notebooks` folders.\n\n## Dependency Management & Reproducibility\n\n1. Always keep your abstract (unpinned) dependencies updated in `environment.yml` and eventually\n in `setup.cfg` if you want to ship and install your package via `pip` later on.\n2. Create concrete dependencies as `environment.lock.yml` for the exact reproduction of your\n environment with:\n ```bash\n conda env export -n evafs -f environment.lock.yml\n ```\n For multi-OS development, consider using `--no-builds` during the export.\n3. Update your current environment with respect to a new `environment.lock.yml` using:\n ```bash\n conda env update -f environment.lock.yml --prune\n ```\n## Project Organization\n\n```\n\u251c\u2500\u2500 AUTHORS.md <- List of developers and maintainers.\n\u251c\u2500\u2500 CHANGELOG.md <- Changelog to keep track of new features and fixes.\n\u251c\u2500\u2500 CONTRIBUTING.md <- Guidelines for contributing to this project.\n\u251c\u2500\u2500 Dockerfile <- Build a docker container with `docker build .`.\n\u251c\u2500\u2500 LICENSE.txt <- License as chosen on the command-line.\n\u251c\u2500\u2500 README.md <- The top-level README for developers.\n\u251c\u2500\u2500 configs <- Directory for configurations of model & application.\n\u251c\u2500\u2500 data\n\u2502 \u251c\u2500\u2500 external <- Data from third party sources.\n\u2502 \u251c\u2500\u2500 interim <- Intermediate data that has been transformed.\n\u2502 \u251c\u2500\u2500 processed <- The final, canonical data sets for modeling.\n\u2502 \u2514\u2500\u2500 raw <- The original, immutable data dump.\n\u251c\u2500\u2500 docs <- Directory for Sphinx documentation in rst or md.\n\u251c\u2500\u2500 environment.yml <- The conda environment file for reproducibility.\n\u251c\u2500\u2500 models <- Trained and serialized models, model predictions,\n\u2502 or model summaries.\n\u251c\u2500\u2500 notebooks <- Jupyter notebooks. Naming convention is a number (for\n\u2502 ordering), the creator's initials and a description,\n\u2502 e.g. `1.0-fw-initial-data-exploration`.\n\u251c\u2500\u2500 pyproject.toml <- Build configuration. Don't change! Use `pip install -e .`\n\u2502 to install for development or to build `tox -e build`.\n\u251c\u2500\u2500 references <- Data dictionaries, manuals, and all other materials.\n\u251c\u2500\u2500 reports <- Generated analysis as HTML, PDF, LaTeX, etc.\n\u2502 \u2514\u2500\u2500 figures <- Generated plots and figures for reports.\n\u251c\u2500\u2500 scripts <- Analysis and production scripts which import the\n\u2502 actual PYTHON_PKG, e.g. train_model.\n\u251c\u2500\u2500 setup.cfg <- Declarative configuration of your project.\n\u251c\u2500\u2500 setup.py <- [DEPRECATED] Use `python setup.py develop` to install for\n\u2502 development or `python setup.py bdist_wheel` to build.\n\u251c\u2500\u2500 src\n\u2502 \u2514\u2500\u2500 evafs <- Actual Python package where the main functionality goes.\n\u251c\u2500\u2500 tests <- Unit tests which can be run with `pytest`.\n\u251c\u2500\u2500 .coveragerc <- Configuration for coverage reports of unit tests.\n\u251c\u2500\u2500 .isort.cfg <- Configuration for git hook that sorts imports.\n\u2514\u2500\u2500 .pre-commit-config.yaml <- Configuration of pre-commit git hooks.\n```\n\n## Contribution\nEvaFS employs [Tox](https://tox.wiki/en/stable/) to automate Package tasks such as packaging, testing and building.\n\n```bash\ntox -e docs # to build your documentation\ntox -e build # to build your package distribution\ntox -e publish # to test your project uploads correctly in test.pypi.org\ntox -e publish -- --repository pypi # to release your package to PyPI\ntox -av # to list all the tasks available\n```\n\n<!-- pyscaffold-notes -->\n\n## Note\n\nThis project has been set up using [PyScaffold] 4.5 and the [dsproject extension] 0.0.post163+g5845251.\n\n[conda]: https://docs.conda.io/\n[pre-commit]: https://pre-commit.com/\n[Jupyter]: https://jupyter.org/\n[nbstripout]: https://github.com/kynan/nbstripout\n[Google style]: http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[PyScaffold]: https://pyscaffold.org/\n[dsproject extension]: https://github.com/pyscaffold/pyscaffoldext-dsproject\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A storage system middleware",
"version": "0.0.11",
"project_urls": {
"Documentation": "https://pyscaffold.org/",
"Homepage": "https://github.com/pyscaffold/pyscaffold/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3df2dc8e5876c41b08c7e6f4de9d01bb666349d3d3dee865f9f92c89ecc98e95",
"md5": "93e940b598d4828657eea65ca6a088bc",
"sha256": "3196bf0c72935b0905a09e4952c942fb46cecb3ef9ed324c27e4f755bcf0744c"
},
"downloads": -1,
"filename": "evafs-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93e940b598d4828657eea65ca6a088bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7283,
"upload_time": "2024-04-23T19:16:35",
"upload_time_iso_8601": "2024-04-23T19:16:35.948966Z",
"url": "https://files.pythonhosted.org/packages/3d/f2/dc8e5876c41b08c7e6f4de9d01bb666349d3d3dee865f9f92c89ecc98e95/evafs-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d50318f806431cddf2767385c9eb36d63e7e163adf9905835b09e1adf1c0f2ee",
"md5": "a09aa1f1a618b71dff2fa42c5c4598e2",
"sha256": "e7a03baac02512199b15b57f3cfdddd277a0960b9d7ada746b37a3f964f3e1cf"
},
"downloads": -1,
"filename": "evafs-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "a09aa1f1a618b71dff2fa42c5c4598e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27550,
"upload_time": "2024-04-23T19:16:37",
"upload_time_iso_8601": "2024-04-23T19:16:37.604985Z",
"url": "https://files.pythonhosted.org/packages/d5/03/18f806431cddf2767385c9eb36d63e7e163adf9905835b09e1adf1c0f2ee/evafs-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 19:16:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyscaffold",
"github_project": "pyscaffold",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "evafs"
}
JSON
