[](https://pyscaffold.org/)
[](https://pypi.org/project/cWeb/)
# cWeb
> The client for web renders web pages and transforms them into whatever format you need.
## CLI Installation
```
pip install cWeb
```
```
cWeb https://sanchezcarlosjr.notion.site/Learn-to-make-cool-ideas-here-d80df9eb663f440aa8076c6422c54a93?pvs=4
```
## Full Installation
In order to set up the necessary environment:
1. review and uncomment what you need in `environment.yml` and create an environment `cWeb` with the help of [conda]:
```
conda env create -f environment.yml
```
2. activate the new environment with:
```
conda activate cWeb
```
> **_NOTE:_** The conda environment will have cWeb 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 cWeb -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
│ └── cweb <- 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.
```
<!-- pyscaffold-notes -->
## Note
This project has been set up using [PyScaffold] 4.5 and the [dsproject extension] 0.0.post158+g5fb5c40.d20231203.
[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": "cWeb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "sanchezcarlosjr",
"author_email": "24639141+sanchezcarlosjr@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/25/3a/840b02295ddf83b2bbea1353d13d03babe4f525be29896197f291ee2e994/cWeb-1.0.0.tar.gz",
"platform": "any",
"description": "[](https://pyscaffold.org/)\n[](https://pypi.org/project/cWeb/)\n\n# cWeb\n\n> The client for web renders web pages and transforms them into whatever format you need.\n\n## CLI Installation\n```\n pip install cWeb\n```\n\n```\n cWeb https://sanchezcarlosjr.notion.site/Learn-to-make-cool-ideas-here-d80df9eb663f440aa8076c6422c54a93?pvs=4\n```\n\n## Full 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 `cWeb` with the help of [conda]:\n ```\n conda env create -f environment.yml\n ```\n2. activate the new environment with:\n ```\n conda activate cWeb\n ```\n\n> **_NOTE:_** The conda environment will have cWeb 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 cWeb -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 cweb <- 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<!-- pyscaffold-notes -->\n\n## Note\n\nThis project has been set up using [PyScaffold] 4.5 and the [dsproject extension] 0.0.post158+g5fb5c40.d20231203.\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": "The client for web renders web pages and transforms them into whatever format you need.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://pyscaffold.org/",
"Homepage": "https://github.com/pyscaffold/pyscaffold/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b35f49f34059338500fc5ae1d88185ec4a39deeddd903fc51ae37e315d0c2c31",
"md5": "c5f1b2994a3af5d823779dc73ad4904e",
"sha256": "30905a735cd3c2d647a30ae437f1b7152083e2f600729f24b12c45aa9186f5dc"
},
"downloads": -1,
"filename": "cWeb-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5f1b2994a3af5d823779dc73ad4904e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6851,
"upload_time": "2024-01-29T16:42:21",
"upload_time_iso_8601": "2024-01-29T16:42:21.988140Z",
"url": "https://files.pythonhosted.org/packages/b3/5f/49f34059338500fc5ae1d88185ec4a39deeddd903fc51ae37e315d0c2c31/cWeb-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "253a840b02295ddf83b2bbea1353d13d03babe4f525be29896197f291ee2e994",
"md5": "c5c9b8b22050417dc74a725d07d09848",
"sha256": "299126a54915bb60981f2c9b17b70cb506e030b8559f48c1ba1e5d5a782f629a"
},
"downloads": -1,
"filename": "cWeb-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c5c9b8b22050417dc74a725d07d09848",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27040,
"upload_time": "2024-01-29T16:42:23",
"upload_time_iso_8601": "2024-01-29T16:42:23.999899Z",
"url": "https://files.pythonhosted.org/packages/25/3a/840b02295ddf83b2bbea1353d13d03babe4f525be29896197f291ee2e994/cWeb-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 16:42:23",
"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": "cweb"
}
JSON
