openoligo 0.1.0

An open-source platform for programmatically interacting with and managing Nucleic acid sequences synthesis processes.

OpenOligo

OpenOligo is an open-source platform for programmatically interacting with and managing DNA synthesis processes.

Prerequisites

• Python 3.8+
• Poetry for Python dependency management.
• Docker (Optional)

Getting Started

1. Clone the repository

git clone https://github.com/techno/OpenOligo.git
cd OpenOligo

Replace with your actual GitHub username.

2. Install Python

Download and install Python from the official site.

3. Install Poetry

To install Poetry on your system, open a command prompt and run:

pip install poetry

4. Install Project Dependencies

To install the dependencies needed for the project, navigate to the project directory (where the pyproject.toml is located) in your terminal, and run:

poetry install

5. Run the Code

poetry run openoligo

Using the Makefile

This project includes a Makefile that makes it easier to run common tasks. Here are the available targets:

• make help: Print help information about the available targets.
• make lint: Run linters on the code, including flake8, black (for code formatting checks), and isort (for import ordering checks).
• make type: Run the mypy type checker on the code.

To use the Makefile, open your command prompt or terminal, navigate to the project directory, and run the make command followed by the target. For example, to run linters on the code, use:

make lint

Please make sure that you have make installed on your system. On Windows, you may need to install make via a package manager like Chocolatey, or use a POSIX compatibility layer like Git Bash or Cygwin.