scriptutils.directories

Module Contents

Functions

distribution_dir() → str

Returns the root directory for the distribution.

package_dirs() → List[str]

Find all packages in the repository

package_excel(directory) → str

Check that there is exactly one excel package file (ignoring temp-files)

regularize_directory(dir: str)

Ensure that a package has one export directory, no other subdirectories, and precisely one package Excel file

Attributes

DISTRIBUTION_FASTA

File name for the distribution FASTA export for synthesis, to be located in the root directory

DISTRIBUTION_GENBANK

File name for the distribution GenBank export for synthesis/review, to be located in the root directory

DISTRIBUTION_NAME

File name for the distribution as a whole, to be located in the root directory

EXPORT_DIRECTORY

Export directory into which sheets and other products will be placed

EXPORT_SHEETS

List of sheets to export, which will be written as CSVs with the same name

SBOL_EXPORT_NAME

Name of the base SBOL3 export name (not filled in with details)

SBOL_PACKAGE_NAME

Name of the fully assembled SBOL3 package

DISTRIBUTION_FASTA = distribution_synthesis_inserts.fasta

File name for the distribution FASTA export for synthesis, to be located in the root directory

DISTRIBUTION_GENBANK = distribution.gb

File name for the distribution GenBank export for synthesis/review, to be located in the root directory

DISTRIBUTION_NAME = distribution.nt

File name for the distribution as a whole, to be located in the root directory

EXPORT_DIRECTORY = views

Export directory into which sheets and other products will be placed

EXPORT_SHEETS = ['Parts and Devices', 'Libraries and Composites']

List of sheets to export, which will be written as CSVs with the same name

SBOL_EXPORT_NAME = package_specification.nt

Name of the base SBOL3 export name (not filled in with details)

SBOL_PACKAGE_NAME = package.nt

Name of the fully assembled SBOL3 package

distribution_dir() str

Returns the root directory for the distribution.

Returns

Path for distribution directory

package_dirs() List[str]

Find all packages in the repository

List of package directory path names

package_excel(directory) str

Check that there is exactly one excel package file (ignoring temp-files)

Path to package Excel file

regularize_directory(dir: str)

Ensure that a package has one export directory, no other subdirectories, and precisely one package Excel file