{"id":16314812,"url":"https://github.com/smarie/python-valid8","last_synced_at":"2025-03-16T14:30:51.851Z","repository":{"id":62586947,"uuid":"108105823","full_name":"smarie/python-valid8","owner":"smarie","description":"Yet another validation lib ;). Provides tools for general-purpose variable validation, function inputs/outputs validation as well as class fields validation. All entry points raise consistent ValidationError including all contextual details, with dynamic inheritance of ValueError/TypeError as appropriate.","archived":false,"fork":false,"pushed_at":"2021-01-29T11:32:19.000Z","size":5114,"stargazers_count":29,"open_issues_count":12,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-11T20:52:06.499Z","etag":null,"topics":["arg","args","argument","check","checker","contract","decorate","decorator","input","python","valid","validate","validation","validator","value"],"latest_commit_sha":null,"homepage":"https://smarie.github.io/python-valid8/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smarie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-24T09:32:24.000Z","updated_at":"2024-12-29T06:22:57.000Z","dependencies_parsed_at":"2022-11-03T22:38:58.746Z","dependency_job_id":null,"html_url":"https://github.com/smarie/python-valid8","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarie%2Fpython-valid8","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarie%2Fpython-valid8/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarie%2Fpython-valid8/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarie%2Fpython-valid8/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smarie","download_url":"https://codeload.github.com/smarie/python-valid8/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243818192,"owners_count":20352629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arg","args","argument","check","checker","contract","decorate","decorator","input","python","valid","validate","validation","validator","value"],"created_at":"2024-10-10T21:55:20.164Z","updated_at":"2025-03-16T14:30:51.506Z","avatar_url":"https://github.com/smarie.png","language":"Python","readme":"# python-validate (valid8)\n\n*\"valid8ing is not a crime\" ;-)*\n\n[![Python versions](https://img.shields.io/pypi/pyversions/valid8.svg)](https://pypi.python.org/pypi/valid8/) [![Build Status](https://travis-ci.com/smarie/python-valid8.svg?branch=master)](https://travis-ci.com/smarie/python-valid8) [![Tests Status](https://smarie.github.io/python-valid8/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-valid8/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-valid8/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-valid8)\n\n[![Documentation](https://img.shields.io/badge/doc-latest-blue.svg)](https://smarie.github.io/python-valid8/) [![PyPI](https://img.shields.io/pypi/v/valid8.svg)](https://pypi.python.org/pypi/valid8/) [![Downloads](https://pepy.tech/badge/valid8)](https://pepy.tech/project/valid8) [![Downloads per week](https://pepy.tech/badge/valid8/week)](https://pepy.tech/project/valid8) [![GitHub stars](https://img.shields.io/github/stars/smarie/python-valid8.svg)](https://github.com/smarie/python-valid8/stargazers)\n\n`valid8` provides user-friendly tools for \n\n * general-purpose inline validation, \n * function inputs/outputs validation \n * class fields validation. \n \nAll entry points raise consistent `ValidationError` including all contextual details, with dynamic inheritance of `ValueError`/`TypeError` as appropriate. Originally from the [autoclass](https://smarie.github.io/python-autoclass/) project.\n\n**This is the readme for developers.** The documentation for users is available here: [https://smarie.github.io/python-valid8/](https://smarie.github.io/python-valid8/)\n\n## Want to contribute ?\n\nContributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.\n\nHere is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-valid8/issues](https://github.com/smarie/python-valid8/issues)\n\n## Installing all requirements\n\nIn order to install all requirements, including those for tests and packaging, use the following command:\n\n```bash\npip install -r ci_tools/requirements-pip.txt\n```\n\n## Running the tests\n\nThis project uses `pytest`.\n\n```bash\npytest -v valid8/tests/\n```\n\n## Packaging\n\nThis project uses `setuptools_scm` to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases: \n\n```bash\npython setup.py egg_info bdist_wheel rotate -m.whl -k3\n```\n\n## Generating the documentation page\n\nThis project uses `mkdocs` to generate its documentation page. Therefore building a local copy of the doc page may be done using:\n\n```bash\nmkdocs build -f docs/mkdocs.yml\n```\n\n## Generating the test reports\n\nThe following commands generate the html test report and the associated badge. \n\n```bash\npytest --junitxml=junit.xml -v valid8/tests/\nant -f ci_tools/generate-junit-html.xml\npython ci_tools/generate-junit-badge.py\n```\n\n### PyPI Releasing memo\n\nThis project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:\n\n```bash\ntwine upload dist/* -r pypitest\ntwine upload dist/*\n```\n\n### Merging pull requests with edits - memo\n\nAx explained in github ('get commandline instructions'):\n\n```bash\ngit checkout -b \u003cgit_name\u003e-\u003cfeature_branch\u003e master\ngit pull https://github.com/\u003cgit_name\u003e/python-valid8.git \u003cfeature_branch\u003e --no-commit --ff-only\n```\n\nif the second step does not work, do a normal auto-merge (do not use **rebase**!):\n\n```bash\ngit pull https://github.com/\u003cgit_name\u003e/python-valid8.git \u003cfeature_branch\u003e --no-commit\n```\n\nFinally review the changes, possibly perform some modifications, and commit.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarie%2Fpython-valid8","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmarie%2Fpython-valid8","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarie%2Fpython-valid8/lists"}