معرفی شرکت ها
cidc-schemas-0.9.5
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.3
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.15
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.1
0.3.1
0.3.0
0.26.9
0.26.8
0.26.7
0.26.6
0.26.5
0.26.4
0.26.3
0.26.22
0.26.21
0.26.20
0.26.2
0.26.19
0.26.18
0.26.17
0.26.16
0.26.15
0.26.14
0.26.13
0.26.12
0.26.11
0.26.10
0.26.1
0.26.0
0.25.9
0.25.8
0.25.7
0.25.6
0.25.54
0.25.53
0.25.52
0.25.51
0.25.50
0.25.5
0.25.49
0.25.48
0.25.47
0.25.46
0.25.45
0.25.44
0.25.43
0.25.42
0.25.41
0.25.40
0.25.4
0.25.39
0.25.38
0.25.37
0.25.36
0.25.35
0.25.34
0.25.33
0.25.32
0.25.31
0.25.30
0.25.3
0.25.29
0.25.28
0.25.27
0.25.26
0.25.25
0.25.24
0.25.23
0.25.22
0.25.21
0.25.20
0.25.2
0.25.19
0.25.18
0.25.17
0.25.16
0.25.15
0.25.14
0.25.13
0.25.12
0.25.11
0.25.10
0.25.0
0.24.9
0.24.8
0.24.7
0.24.6
0.24.53
0.24.52
0.24.51
0.24.50
0.24.5
0.24.49
0.24.48
0.24.47
0.24.46
0.24.45
0.24.44
0.24.43
0.24.42
0.24.41
0.24.40
0.24.4
0.24.39
0.24.38
0.24.37
0.24.36
0.24.35
0.24.34
0.24.33
0.24.32
0.24.31
0.24.30
0.24.3
0.24.29
0.24.28
0.24.27
0.24.26
0.24.25
0.24.24
0.24.23
0.24.22
0.24.21
0.24.20
0.24.2
0.24.19
0.24.18
0.24.17
0.24.16
0.24.15
0.24.14
0.24.13
0.24.12
0.24.11
0.24.10
0.24.1
0.24.0
0.23.9
0.23.8
0.23.7
0.23.6
0.23.5
0.23.4
0.23.3
0.23.2
0.23.18
0.23.17
0.23.16
0.23.15
0.23.14
0.23.13
0.23.12
0.23.11
0.23.10
0.23.1
0.23.0
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.1
0.21.0
0.20.7
0.20.6
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0
0.2.1
0.2.0
0.19.1
0.19.0
0.18.9
0.18.8
0.18.7
0.18.6
0.18.5
0.18.4
0.18.3
0.18.2
0.18.10
0.18.1
0.18.0
0.17.3
0.17.2
0.17.1
0.17.0
0.16.9
0.16.8
0.16.7
0.16.6
0.16.5
0.16.4
0.16.3
0.16.26
0.16.25
0.16.24
0.16.23
0.16.22
0.16.21
0.16.20
0.16.2
0.16.19
0.16.18
0.16.17
0.16.16
0.16.15
0.16.14
0.16.13
0.16.12
0.16.11
0.16.10
0.16.1
0.16.0
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.8
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.5
0.13.4
0.13.3
0.13.2
0.13.1
0.13.0
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.2
0.12.1
0.12.0
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.26.9
0.26.8
0.26.7
0.26.6
0.26.5
0.26.4
0.26.3
0.26.22
0.26.21
0.26.20
0.26.2
0.26.19
0.26.18
0.26.17
0.26.16
0.26.15
0.26.14
0.26.13
0.26.12
0.26.11
0.26.10
0.26.1
0.26.0
0.25.9
0.25.8
0.25.7
0.25.6
0.25.54
0.25.53
0.25.52
0.25.51
0.25.50
0.25.5
0.25.49
0.25.48
0.25.47
0.25.46
0.25.45
0.25.44
0.25.43
0.25.42
0.25.41
0.25.40
0.25.4
0.25.39
0.25.38
0.25.37
0.25.36
0.25.35
0.25.34
0.25.33
0.25.32
0.25.31
0.25.30
0.25.3
0.25.29
0.25.28
0.25.27
0.25.26
0.25.25
0.25.24
0.25.23
0.25.22
0.25.21
0.25.20
0.25.2
0.25.19
0.25.18
0.25.17
0.25.16
0.25.15
0.25.14
0.25.13
0.25.12
0.25.11
0.25.10
0.25.0
0.24.9
0.24.8
0.24.7
0.24.6
0.24.53
0.24.52
0.24.51
0.24.50
0.24.5
0.24.49
0.24.48
0.24.47
0.24.46
0.24.45
0.24.44
0.24.43
0.24.42
0.24.41
0.24.40
0.24.4
0.24.39
0.24.38
0.24.37
0.24.36
0.24.35
0.24.34
0.24.33
0.24.32
0.24.31
0.24.30
0.24.3
0.24.29
0.24.28
0.24.27
0.24.26
0.24.25
0.24.24
0.24.23
0.24.22
0.24.21
0.24.20
0.24.2
0.24.19
0.24.18
0.24.17
0.24.16
0.24.15
0.24.14
0.24.13
0.24.12
0.24.11
0.24.10
0.24.1
0.24.0
0.23.9
0.23.8
0.23.7
0.23.6
0.23.5
0.23.4
0.23.18
0.23.17
0.23.16
0.23.15
0.23.14
0.23.13
0.23.12
0.23.11
0.23.10
توضیحات
The CIDC data model and tools for working with it.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | cidc-schemas-0.9.5 |
| نام | cidc-schemas |
| نسخه کتابخانه | 0.9.5 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | James Lindsay |
| ایمیل نویسنده | jlindsay@jimmy.harvard.edu |
| آدرس صفحه اصلی | https://github.com/CIMAC-CIDC/schemas |
| آدرس اینترنتی | https://pypi.org/project/cidc-schemas/ |
| مجوز | MIT license |
# cidc-schemas
| Branch | Status | Maintainability | Test Coverage | Code Style |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [master](https://cimac-cidc.github.io/cidc-schemas/) |  | [](https://codeclimate.com/github/CIMAC-CIDC/cidc-schemas/maintainability) | [](https://codeclimate.com/github/CIMAC-CIDC/cidc-schemas/test_coverage) | <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> |
This repository contains formal definitions of the CIDC metadata model using [json-schema](https://json-schema.org/) syntax and vocabulary.
### View documentation at https://cimac-cidc.github.io/cidc-schemas/
## Installation
To install the latest released version, run:
```bash
pip install cidc-schemas
```
## Development
### Project Structure
- **`cidc_schemas/`** - a python module for generating, validating, and reading manifest and assay templates.
- **`schemas/`** - json specifications defining the CIDC metadata model.
- `templates/` - schemas for generating and validating manifest and assay templates.
- `assays/` - schemas for defining assay data models.
- `artifacts/` - schemas for defining artifacts.
- **`docs/`** - the most recent build of the data model documentation, along with templates and scripts for re-generating the documentation.
- **`template_examples/`** - example populated Excel files for template specifications in `schemas/templates`, and `.csv`s auto-generated from those `.xlsx`s that allow to transparently keep track of changes in them.
- **`tests/`** - tests for the `cidc_schemas` module.
- **`.githooks/`** - git hooks, e.g. for auto-generating `.csv`s in `template_examples/` and `.html` documentation files.
### Developer Setup
Install necessary dependencies.
```bash
pip install -r requirements.dev.txt
```
Install and configure pre-commit hooks.
```bash
pre-commit install
```
## JIRA Integration
To set-up the git hook for JIRA integration, run:
```bash
ln -s ../../.githooks/commit-msg .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg
rm .git/hooks/commit-msg.sample
```
This symbolic link is necessary to correctly link files in `.githooks` to `.git/hooks`. Note that setting the `core.hooksPath` configuration variable would lead to [pre-commit failing](https://github.com/pre-commit/pre-commit/issues/1198). The `commit-msg` hook [runs after](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) the `pre-commit` hook, hence the two are de-coupled in this workflow.
To associate a commit with an issue, you will need to reference the JIRA Issue key (For eg 'CIDC-1111') in the corresponding commit message.
### Running tests
This repository has unit tests in the _tests_ folder. After installing dependencies
the tests can be run via the command
```bash
pytest tests
```
### Building documentation
Pre-commit hooks ensure documentation is automatically up-to date. To build the documentation manually, run the following commands:
```bash
python setup.py install # install helpers from the cidc_schemas library
python docs/generate_docs.py
```
This will output the generated html documents in `docs/docs`. If the updated docs are pushed up and merged into master, they will be viewable at https://cimac-cidc.github.io/cidc-schemas/.
## Using the Command-Line Interface
This project comes with a command-line interface for validating schemas and generating/validating assay and manifest templates.
### Install the CLI
Clone the repository and cd into it
```bash
git clone git@github.com:CIMAC-CIDC/cidc-schemas.git
cd cidc-schemas
```
Install the `cidc_schemas` package (this adds the `cidc_schemas` CLI to your console)
```bash
python setup.py install
```
Run `cidc_schemas --help` to see available options.
If you're making changes to the module and want those changes to be reflected in the CLI without reinstalling the `cidc_schemas` module every time, run
```bash
python3 -m cidc_schemas.cli [args]
```
### Generate templates
Create a template for a given template configuration.
```bash
cidc_schemas generate_template -m templates/manifests/pbmc_template.json -o pbmc.xlsx
```
### Validate filled-out templates
Check that a populated template file is valid with respect to a template specification.
```bash
cidc_schemas validate_template -m templates/manifests/pbmc_template.json -x template_examples/pbmc_template.xlsx
```
### Validate JSON schemas
Check that a JSON schema conforms to the JSON Schema specifications.
```bash
cidc_schemas validate_schema -f shipping_core.json
```
نیازمندی
| مقدار | نام |
|---|---|
| ==1.1.4 | dateparser |
| ==1.1.6 | xlsxwriter |
| ==1.1 | argparse |
| ~=5.1 | pyyaml |
| ==3.0.1 | jsonschema |
| ==3.0.7 | openpyxl |
| ==1.6.1 | jsonmerge |
| ~=4.3.0 | deepdiff |
| ==2.0 | jsonpointer |
| ==1.2.4 | pandas |
| ~=3.0.3 | jinja2 |
| ==0.1.23 | cidc-ngs-pipeline-api |
| ==2.0.1 | markupsafe |
| ==2022.3.2 | regex |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6 | Python |
نحوه نصب
نصب پکیج whl cidc-schemas-0.9.5:
pip install cidc-schemas-0.9.5.whl
نصب پکیج tar.gz cidc-schemas-0.9.5:
pip install cidc-schemas-0.9.5.tar.gz