Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions .devcontainer/Dockerfile

This file was deleted.

24 changes: 0 additions & 24 deletions .devcontainer/devcontainer.json

This file was deleted.

15 changes: 3 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,14 @@ environment for Pynteny:

1. Fork and download repo, cd to downloaded directory. You should create a new branch to work on your issue.

2. Create a virtual environment and install Pynteny in editable mode:
2. Create a virtual environment and install Pynteny (in editable mode) together
with its development tools:

```bash
python -m venv .venv
source .venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt
```

3. Run tests
Expand All @@ -54,17 +56,6 @@ pip install -e .
python -m unittest discover tests
```

A conda environment file (`envs/pynteny-dev.yml`) is still provided for
contributors who prefer conda, but it is no longer required.

## Using GitHub codespaces

Alternatively, you can directly work on a developer environment in the browser within GitHub's codespaces. To set this environment up:

1. Fork repository and create new branch for your issue.

2. Start a new Codespace for the new branch. GitHub will build an environment with all required dependencies as well as pynteny the first time (it will take a couple of minutes). Pynteny will be installed in a conda environment named "pynteny-dev".

## Building the documentation

The documentation is formed by a series of markdown files located in directory [docs](https://github.com/Robaina/Pynteny/tree/main/docs). This repo uses [mkdocs](https://www.mkdocs.org/) to automatically generate documentation pages from markdown files. Also, [MathJax](https://github.com/mathjax/MathJax) syntax is allowed!
Expand Down
28 changes: 0 additions & 28 deletions envs/pynteny-dev.yml

This file was deleted.

20 changes: 20 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Development dependencies for Pynteny.
# Install on top of an editable install of the package:
# pip install -e .
# pip install -r requirements-dev.txt
#
# Runtime dependencies (pyhmmer, pyrodigal, pyfastx, ...) are declared in
# pyproject.toml and installed by `pip install -e .`.

# Linting / formatting / tests
ruff
black
coverage

# Documentation
mkdocs
mkdocs-gen-files
pymdown-extensions
mkdocs-jupyter
mkdocstrings[python]
argmark
Loading