enacli
Introduction
enacli is a command-line tool designed to facilitate the validation and submission of data to the European Nucleotide Archive (ENA). This tool streamlines the process of preparing and uploading data files, ensuring they meet ENA's submission requirements.
Installation
sudo apt install lftp
pip install enacli
Resources
Usage
enacli -h
1. Project Submission
Usage
enacli project -h
Example
enacli project -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file (template: templates/templates.xlsx)-t: Use Webin test service (optional)
2. Sample Submission
Usage
enacli sample -h
Example
enacli sample -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file (template: templates/templates.xlsx)-t: Use Webin test service (optional)
3. Run Submission
Usage
enacli run -h
Example
enacli run -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -i test_data/run -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file (template: templates/templates.xlsx)-i: Input directory for files declared in the manifest file-C: The center name of the submitter (mandatory for broker accounts)-t: Use Webin test service (optional)
4. Genome Assembly Submissions
Usage
enacli genome -h
Example
enacli genome -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -i test_data/genome -c genome -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file (template: templates/templates.xlsx)-i: Input directory for files declared in the manifest file-c: Assembly submission type (choices: genome, transcriptome)-C: The center name of the submitter (mandatory for broker accounts)-t: Use Webin test service (optional)
5. Targeted Command
The targeted command facilitates the submission of targeted sequences to the public repository ENA (European Nucleotide Archive).
Usage Example
enacli targeted -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -i test_data/targeted -t
Options
-u,--username: Webin submission account (e.g., Webin-XXX)-p,--password: Password for the submission account-m,--manifestFile: Path to the manifest file specifying the details of the submission. The manifest file should follow the template provided intemplates/templates.xlsx-i,--inputDir: Path to the input directory containing the files declared in the manifest file-C,--centerName: The center name of the submitter (mandatory for broker accounts)-t,--test: Use Webin test service instead of the production service
6. Other Submission
Usage
enacli other -h
Example
enacli other -u Webin-XXXX -p 'XXXXXX' -m templates/templates.xlsx -i test_data/other -a AMR_ANTIBIOGRAM -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file (template: templates/templates.xlsx)-i: Input directory for files declared in the manifest file-a: Analysis type (choices: GENOME_MAP, REFERENCE_ALIGNMENT, SEQUENCE_ANNOTATION, ASSEMBLY_GRAPH, PROCESSED_READ, PATHOGEN_ANALYSIS, AMR_ANTIBIOGRAM, COVID-19_FILTERED_VCF, COVID-19_CONSENSUS, PHYLOGENY_ANALYSIS)-C: The center name of the submitter (mandatory for broker accounts)-t: Use Webin test service (optional)
Validating Antimicrobial Resistance (AMR) Data
When submitting AMR data, it is crucial to ensure that each column in your antibiogram files adheres to specific validation rules:
- bioSample_ID: Must contain 'SAM' or 'ERS' as part of the identifier.
- species: Must be validated against the ENA taxonomy database to ensure correct scientific naming.
- antibiotic_name: Must match the list provided in antibiotics.txt.
- ast_standard: Must be one of the accepted standards (e.g., CLSI, EUCAST, CA-SFM, BSAC, DIN, SIR or WRG).
- breakpoint_version: Ensures compatibility with the chosen AST standard.
- laboratory_typing_method: Must be one of the predefined methods (e.g., BROTH DILUTION, MICROBROTH DILUTION, AGAR DILUTION or DISC-DIFFUSION, NEO-SENSITABS, ETEST).
- measurement: Must fall within valid ranges depending on the typing method.
- measurement_units: Must be appropriate for the typing method (e.g., 'mg/L' for dilution methods or 'mm' for diffusion methods).
- measurement_sign: Must be a valid comparison operator (e.g., >, <, =).
- resistance_phenotype: Must be one of the accepted phenotypes (e.g., intermediate, susceptible, resistant, non-susceptible or not-defined).
- platform: While not always mandatory, must be consistent with the data submitted.
For each column, the validation ensures that the data complies with ENA standards, preventing errors and ensuring smooth submission.
7. enacli All (the magic🪄 option)
Description
The all command combines all submissions (projects, samples, runs, genome assemblies, targets, and other analysis objects) into a single command line. This aims to streamline submission to ENA.
Help
enacli all -h
Example
enacli all -u webin-XXXX -p 'XXXXXX' -m templates/templates_all.xlsx -i test_data/all/ -c genome -a AMR_ANTIBIOGRAM -t
Options
-u: Webin submission account-p: Password for the submission account-m: Manifest file-i: Input directory for all files declared in the manifest file (optional)-a: Analysis type (optional)-c: Assembly submission type (optional)-C: Center name (optional)-t: Test submission (optional)
Contact Information
For any errors or assistance, please contact the ENA helpdesk.
License
This project is licensed under the MIT License.
This documentation provides clear and concise instructions for installing, using, and troubleshooting the `enacli` tool. It also includes specific validation steps for AMR data, ensuring users submit accurate and valid information to the ENA.
Metadata
Release files for enacli 2.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| enacli-2.0.3.tar.gz | 58.5 MB | Without provenance | Details for enacli-2.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| enacli-2.0.3-py3-none-any.whl | Python 3 | none | any | Details for enacli-2.0.3-py3-none-any.whl |
Total release size: 117.1 MB
Release files / enacli-2.0.3.tar.gz
| Download URL | enacli-2.0.3.tar.gz |
|---|---|
| Size | 58.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48deb3e6e69fdf667520a52e90ba03d82378c2b47cf7409f6aabb2f0d2e9d1c0
|
|
BLAKE2b-256 checksum How to use checksums |
38dd1ab8c6d72c22651a683d40fe8ad45ea19f5ae1351a23d29d727f8ca806fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.9
|
Release files / enacli-2.0.3-py3-none-any.whl
| Download URL | enacli-2.0.3-py3-none-any.whl |
|---|---|
| Size | 58.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9eb910ef9931e7499c45c83f73a3a86e04278e8a19950daebedb2d872c525aed
|
|
BLAKE2b-256 checksum How to use checksums |
2e5afb3aa0902988fb69461280354e774cb7d2719f253b76e8e88e04fab5bc53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.9
|
Security for enacli 2.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.