scanitd 0.9.0__tar.gz → 0.9.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- scanitd-0.9.2/.github/workflows/release.yml +50 -0
- scanitd-0.9.2/.gitignore +119 -0
- scanitd-0.9.2/.pre-commit-config.yaml +32 -0
- scanitd-0.9.2/.readthedocs.yaml +19 -0
- scanitd-0.9.2/CODE_OF_CONDUCT.md +115 -0
- scanitd-0.9.2/CONTRIBUTING.md +114 -0
- scanitd-0.9.2/MANIFEST.in +9 -0
- scanitd-0.9.2/Makefile +87 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/PKG-INFO +52 -27
- {scanitd-0.9.0 → scanitd-0.9.2}/README.md +28 -6
- scanitd-0.9.2/docs/Makefile +20 -0
- scanitd-0.9.2/docs/make.bat +35 -0
- scanitd-0.9.2/docs/source/api/base.rst +36 -0
- scanitd-0.9.2/docs/source/api/cli.rst +13 -0
- scanitd-0.9.2/docs/source/api/inference.rst +28 -0
- scanitd-0.9.2/docs/source/api/writer.rst +25 -0
- scanitd-0.9.2/docs/source/changelog.md +43 -0
- scanitd-0.9.2/docs/source/conf.py +99 -0
- scanitd-0.9.2/docs/source/contributing.md +64 -0
- scanitd-0.9.2/docs/source/guide/installation.md +42 -0
- scanitd-0.9.2/docs/source/guide/output.md +95 -0
- scanitd-0.9.2/docs/source/guide/quickstart.md +69 -0
- scanitd-0.9.2/docs/source/guide/usage.md +118 -0
- scanitd-0.9.2/docs/source/index.rst +45 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/pyproject.toml +61 -74
- scanitd-0.9.2/requirements_dev.txt +9 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/__init__.py +1 -1
- scanitd-0.9.2/src/scanitd/base/__init__.py +30 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/base/basic.py +171 -44
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/base/basic_read.py +15 -6
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/base/cigar.py +22 -2
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/cli/cli.py +35 -13
- scanitd-0.9.2/src/scanitd/inference/__init__.py +10 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/inference/helper.py +105 -14
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/inference/main.py +72 -11
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/inference/sr_resuer.py +40 -2
- scanitd-0.9.2/src/scanitd/mtype.py +68 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/writer/__init__.py +1 -1
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/writer/vcf_writer.py +61 -11
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/writer/writer.py +16 -5
- scanitd-0.9.2/tests/__init__.py +1 -0
- scanitd-0.9.2/tests/conftest.py +68 -0
- scanitd-0.9.2/tests/test_basic.py +273 -0
- scanitd-0.9.2/tests/test_basic_read.py +122 -0
- scanitd-0.9.2/tests/test_cigar.py +92 -0
- scanitd-0.9.2/tests/test_helper.py +201 -0
- scanitd-0.9.2/tests/test_scanitd.py +18 -0
- scanitd-0.9.2/tests/test_vcf_writer.py +211 -0
- scanitd-0.9.2/tox.ini +7 -0
- scanitd-0.9.0/setup.py +0 -49
- scanitd-0.9.0/src/scanitd/base/__init__.py +0 -27
- scanitd-0.9.0/src/scanitd/inference/__init__.py +0 -6
- scanitd-0.9.0/src/scanitd/mtype.py +0 -32
- {scanitd-0.9.0 → scanitd-0.9.2}/LICENSE +0 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/cli/__init__.py +0 -0
- {scanitd-0.9.0 → scanitd-0.9.2}/src/scanitd/py.typed +0 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
name: Release to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Build distribution
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
|
|
15
|
+
- name: Install uv
|
|
16
|
+
uses: astral-sh/setup-uv@v3
|
|
17
|
+
|
|
18
|
+
- name: Install dependencies
|
|
19
|
+
run: uv sync --group dev
|
|
20
|
+
|
|
21
|
+
- name: Run tests
|
|
22
|
+
run: uv run pytest
|
|
23
|
+
|
|
24
|
+
- name: Build sdist and wheel
|
|
25
|
+
run: uv build
|
|
26
|
+
|
|
27
|
+
- name: Upload distribution artifacts
|
|
28
|
+
uses: actions/upload-artifact@v4
|
|
29
|
+
with:
|
|
30
|
+
name: python-package-distributions
|
|
31
|
+
path: dist/
|
|
32
|
+
|
|
33
|
+
publish:
|
|
34
|
+
name: Publish to PyPI
|
|
35
|
+
needs: build
|
|
36
|
+
runs-on: ubuntu-latest
|
|
37
|
+
environment:
|
|
38
|
+
name: pypi
|
|
39
|
+
url: https://pypi.org/p/scanitd
|
|
40
|
+
permissions:
|
|
41
|
+
id-token: write
|
|
42
|
+
steps:
|
|
43
|
+
- name: Download distribution artifacts
|
|
44
|
+
uses: actions/download-artifact@v4
|
|
45
|
+
with:
|
|
46
|
+
name: python-package-distributions
|
|
47
|
+
path: dist/
|
|
48
|
+
|
|
49
|
+
- name: Publish to PyPI
|
|
50
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
scanitd-0.9.2/.gitignore
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
env/
|
|
12
|
+
build/
|
|
13
|
+
develop-eggs/
|
|
14
|
+
dist/
|
|
15
|
+
downloads/
|
|
16
|
+
data/
|
|
17
|
+
tmp/
|
|
18
|
+
eggs/
|
|
19
|
+
node_modules/
|
|
20
|
+
.eggs/
|
|
21
|
+
lib/
|
|
22
|
+
lib64/
|
|
23
|
+
parts/
|
|
24
|
+
sdist/
|
|
25
|
+
var/
|
|
26
|
+
uv.lock
|
|
27
|
+
wheels/
|
|
28
|
+
*.egg-info/
|
|
29
|
+
.installed.cfg
|
|
30
|
+
*.egg
|
|
31
|
+
|
|
32
|
+
# PyInstaller
|
|
33
|
+
# Usually these files are written by a python script from a template
|
|
34
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
35
|
+
*.manifest
|
|
36
|
+
*.spec
|
|
37
|
+
|
|
38
|
+
# Installer logs
|
|
39
|
+
pip-log.txt
|
|
40
|
+
pip-delete-this-directory.txt
|
|
41
|
+
|
|
42
|
+
# Unit test / coverage reports
|
|
43
|
+
htmlcov/
|
|
44
|
+
.tox/
|
|
45
|
+
.coverage
|
|
46
|
+
.coverage.*
|
|
47
|
+
.cache
|
|
48
|
+
nosetests.xml
|
|
49
|
+
coverage.xml
|
|
50
|
+
*.cover
|
|
51
|
+
.hypothesis/
|
|
52
|
+
.pytest_cache/
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
# Translations
|
|
56
|
+
*.mo
|
|
57
|
+
*.pot
|
|
58
|
+
|
|
59
|
+
# Django stuff:
|
|
60
|
+
*.log
|
|
61
|
+
local_settings.py
|
|
62
|
+
|
|
63
|
+
# Flask stuff:
|
|
64
|
+
instance/
|
|
65
|
+
.webassets-cache
|
|
66
|
+
|
|
67
|
+
# Scrapy stuff:
|
|
68
|
+
.scrapy
|
|
69
|
+
|
|
70
|
+
# Sphinx documentation
|
|
71
|
+
docs/_build/
|
|
72
|
+
|
|
73
|
+
# PyBuilder
|
|
74
|
+
target/
|
|
75
|
+
|
|
76
|
+
# Jupyter Notebook
|
|
77
|
+
.ipynb_checkpoints
|
|
78
|
+
|
|
79
|
+
# Dask worker cache
|
|
80
|
+
dask-worker-space/
|
|
81
|
+
|
|
82
|
+
# pyenv
|
|
83
|
+
.python-version
|
|
84
|
+
|
|
85
|
+
# celery beat schedule file
|
|
86
|
+
celerybeat-schedule
|
|
87
|
+
|
|
88
|
+
# SageMath parsed files
|
|
89
|
+
*.sage.py
|
|
90
|
+
|
|
91
|
+
# dotenv
|
|
92
|
+
.env
|
|
93
|
+
|
|
94
|
+
# virtualenv
|
|
95
|
+
.venv
|
|
96
|
+
venv/
|
|
97
|
+
ENV/
|
|
98
|
+
|
|
99
|
+
# Spyder project settings
|
|
100
|
+
.spyderproject
|
|
101
|
+
.spyproject
|
|
102
|
+
|
|
103
|
+
# Rope project settings
|
|
104
|
+
.ropeproject
|
|
105
|
+
|
|
106
|
+
# mkdocs documentation
|
|
107
|
+
/site
|
|
108
|
+
|
|
109
|
+
# mypy
|
|
110
|
+
.mypy_cache/
|
|
111
|
+
|
|
112
|
+
# IDE settings
|
|
113
|
+
.vscode/
|
|
114
|
+
.idea/
|
|
115
|
+
|
|
116
|
+
# Tool configurations
|
|
117
|
+
.omc/
|
|
118
|
+
.serena/
|
|
119
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
default_language_version:
|
|
2
|
+
node: system
|
|
3
|
+
|
|
4
|
+
repos:
|
|
5
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
6
|
+
rev: v4.6.0
|
|
7
|
+
hooks:
|
|
8
|
+
- id: check-added-large-files
|
|
9
|
+
args: ["--maxkb=15000"]
|
|
10
|
+
- id: check-toml
|
|
11
|
+
types: [toml]
|
|
12
|
+
- id: check-yaml
|
|
13
|
+
- id: end-of-file-fixer
|
|
14
|
+
- id: trailing-whitespace
|
|
15
|
+
|
|
16
|
+
- repo: https://github.com/pre-commit/mirrors-prettier
|
|
17
|
+
rev: v4.0.0-alpha.8
|
|
18
|
+
hooks:
|
|
19
|
+
- id: prettier
|
|
20
|
+
|
|
21
|
+
- repo: https://github.com/asottile/blacken-docs
|
|
22
|
+
rev: 1.16.0
|
|
23
|
+
hooks:
|
|
24
|
+
- id: blacken-docs
|
|
25
|
+
|
|
26
|
+
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
|
27
|
+
rev: "v0.4.2"
|
|
28
|
+
hooks:
|
|
29
|
+
- id: ruff
|
|
30
|
+
args: [--fix, --exit-non-zero-on-fix, --preview, --unsafe-fixes]
|
|
31
|
+
|
|
32
|
+
- id: ruff-format
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Read the Docs configuration file
|
|
2
|
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
3
|
+
|
|
4
|
+
version: 2
|
|
5
|
+
|
|
6
|
+
build:
|
|
7
|
+
os: ubuntu-22.04
|
|
8
|
+
tools:
|
|
9
|
+
python: "3.11"
|
|
10
|
+
|
|
11
|
+
python:
|
|
12
|
+
install:
|
|
13
|
+
- method: pip
|
|
14
|
+
path: .
|
|
15
|
+
extra_requirements:
|
|
16
|
+
- docs
|
|
17
|
+
|
|
18
|
+
sphinx:
|
|
19
|
+
configuration: docs/source/conf.py
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free
|
|
6
|
+
experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex
|
|
7
|
+
characteristics, gender identity and expression, level of experience, education, socio-economic status,
|
|
8
|
+
nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
9
|
+
|
|
10
|
+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
|
|
11
|
+
healthy community.
|
|
12
|
+
|
|
13
|
+
## Our Standards
|
|
14
|
+
|
|
15
|
+
Examples of behavior that contributes to a positive environment for our community include:
|
|
16
|
+
|
|
17
|
+
- Demonstrating empathy and kindness toward other people
|
|
18
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
19
|
+
- Giving and gracefully accepting constructive feedback
|
|
20
|
+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
|
|
21
|
+
experience
|
|
22
|
+
- Focusing on what is best not just for us as individuals, but for the overall community
|
|
23
|
+
|
|
24
|
+
Examples of unacceptable behavior include:
|
|
25
|
+
|
|
26
|
+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
|
27
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
28
|
+
- Public or private harassment
|
|
29
|
+
- Publishing others' private information, such as a physical or email address, without their explicit
|
|
30
|
+
permission
|
|
31
|
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
32
|
+
|
|
33
|
+
## Enforcement Responsibilities
|
|
34
|
+
|
|
35
|
+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and
|
|
36
|
+
will take appropriate and fair corrective action in response to any behavior that they deem
|
|
37
|
+
inappropriate, threatening, offensive, or harmful.
|
|
38
|
+
|
|
39
|
+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code,
|
|
40
|
+
wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will
|
|
41
|
+
communicate reasons for moderation decisions when appropriate.
|
|
42
|
+
|
|
43
|
+
## Scope
|
|
44
|
+
|
|
45
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is
|
|
46
|
+
officially representing the community in public spaces. Examples of representing our community include
|
|
47
|
+
using an official e-mail address, posting via an official social media account, or acting as an appointed
|
|
48
|
+
representative at an online or offline event.
|
|
49
|
+
|
|
50
|
+
## Enforcement
|
|
51
|
+
|
|
52
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
|
|
53
|
+
leaders responsible for enforcement at
|
|
54
|
+
[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
|
|
55
|
+
|
|
56
|
+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
57
|
+
|
|
58
|
+
## Enforcement Guidelines
|
|
59
|
+
|
|
60
|
+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any
|
|
61
|
+
action they deem in violation of this Code of Conduct:
|
|
62
|
+
|
|
63
|
+
### 1. Correction
|
|
64
|
+
|
|
65
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome
|
|
66
|
+
in the community.
|
|
67
|
+
|
|
68
|
+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature
|
|
69
|
+
of the violation and an explanation of why the behavior was inappropriate. A public apology may be
|
|
70
|
+
requested.
|
|
71
|
+
|
|
72
|
+
### 2. Warning
|
|
73
|
+
|
|
74
|
+
**Community Impact**: A violation through a single incident or series of actions.
|
|
75
|
+
|
|
76
|
+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people
|
|
77
|
+
involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified
|
|
78
|
+
period of time. This includes avoiding interactions in community spaces as well as external channels like
|
|
79
|
+
social media. Violating these terms may lead to a temporary or permanent ban.
|
|
80
|
+
|
|
81
|
+
### 3. Temporary Ban
|
|
82
|
+
|
|
83
|
+
**Community Impact**: A serious violation of community standards, including sustained inappropriate
|
|
84
|
+
behavior.
|
|
85
|
+
|
|
86
|
+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community
|
|
87
|
+
for a specified period of time. No public or private interaction with the people involved, including
|
|
88
|
+
unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period.
|
|
89
|
+
Violating these terms may lead to a permanent ban.
|
|
90
|
+
|
|
91
|
+
### 4. Permanent Ban
|
|
92
|
+
|
|
93
|
+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained
|
|
94
|
+
inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of
|
|
95
|
+
individuals.
|
|
96
|
+
|
|
97
|
+
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
|
98
|
+
|
|
99
|
+
## Attribution
|
|
100
|
+
|
|
101
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
|
|
102
|
+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
|
103
|
+
|
|
104
|
+
Community Impact Guidelines were inspired by
|
|
105
|
+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
|
106
|
+
|
|
107
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
108
|
+
[https://www.contributor-covenant.org/faq][faq]. Translations are available
|
|
109
|
+
at [https://www.contributor-covenant.org/translations][translations].
|
|
110
|
+
|
|
111
|
+
[homepage]: https://www.contributor-covenant.org
|
|
112
|
+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
|
113
|
+
[mozilla coc]: https://github.com/mozilla/diversity
|
|
114
|
+
[faq]: https://www.contributor-covenant.org/faq
|
|
115
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Contributor Guide
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in improving this project.
|
|
4
|
+
This project is open-source under the [MIT license] and
|
|
5
|
+
welcomes contributions in the form of bug reports, feature requests, and pull requests.
|
|
6
|
+
|
|
7
|
+
Here is a list of important resources for contributors:
|
|
8
|
+
|
|
9
|
+
- [Source Code]
|
|
10
|
+
- [Documentation]
|
|
11
|
+
- [Issue Tracker]
|
|
12
|
+
- [Code of Conduct]
|
|
13
|
+
|
|
14
|
+
[mit license]: https://opensource.org/licenses/MIT
|
|
15
|
+
[source code]: https://github.com/ylab-hi/scanitd
|
|
16
|
+
[documentation]: https://scanitd.readthedocs.io/
|
|
17
|
+
[issue tracker]: https://github.com/ylab-hi/scanitd/issues
|
|
18
|
+
|
|
19
|
+
## How to report a bug
|
|
20
|
+
|
|
21
|
+
Report bugs on the [Issue Tracker].
|
|
22
|
+
|
|
23
|
+
When filing an issue, make sure to answer these questions:
|
|
24
|
+
|
|
25
|
+
- Which operating system and Python version are you using?
|
|
26
|
+
- Which version of this project are you using?
|
|
27
|
+
- What did you do?
|
|
28
|
+
- What did you expect to see?
|
|
29
|
+
- What did you see instead?
|
|
30
|
+
|
|
31
|
+
The best way to get your bug fixed is to provide a test case,
|
|
32
|
+
and/or steps to reproduce the issue.
|
|
33
|
+
|
|
34
|
+
## How to request a feature
|
|
35
|
+
|
|
36
|
+
Request features on the [Issue Tracker].
|
|
37
|
+
|
|
38
|
+
## How to set up your development environment
|
|
39
|
+
|
|
40
|
+
You need Python 3.9+ and the following tools:
|
|
41
|
+
|
|
42
|
+
- [Poetry]
|
|
43
|
+
- [Nox]
|
|
44
|
+
- [nox-poetry]
|
|
45
|
+
|
|
46
|
+
Install the package with development requirements:
|
|
47
|
+
|
|
48
|
+
```console
|
|
49
|
+
$ poetry install
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
You can now run an interactive Python session,
|
|
53
|
+
or the command-line interface:
|
|
54
|
+
|
|
55
|
+
```console
|
|
56
|
+
$ poetry run python
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
[poetry]: https://python-poetry.org/
|
|
60
|
+
[nox]: https://nox.thea.codes/
|
|
61
|
+
[nox-poetry]: https://nox-poetry.readthedocs.io/
|
|
62
|
+
|
|
63
|
+
## How to test the project
|
|
64
|
+
|
|
65
|
+
Run the full test suite:
|
|
66
|
+
|
|
67
|
+
```console
|
|
68
|
+
$ nox
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
List the available Nox sessions:
|
|
72
|
+
|
|
73
|
+
```console
|
|
74
|
+
$ nox --list-sessions
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
You can also run a specific Nox session.
|
|
78
|
+
For example, invoke the unit test suite like this:
|
|
79
|
+
|
|
80
|
+
```console
|
|
81
|
+
$ nox --session=tests
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Unit tests are located in the _tests_ directory,
|
|
85
|
+
and are written using the [pytest] testing framework.
|
|
86
|
+
|
|
87
|
+
[pytest]: https://pytest.readthedocs.io/
|
|
88
|
+
|
|
89
|
+
## How to submit changes
|
|
90
|
+
|
|
91
|
+
Open a [pull request] to submit changes to this project.
|
|
92
|
+
|
|
93
|
+
Your pull request needs to meet the following guidelines for acceptance:
|
|
94
|
+
|
|
95
|
+
- The Nox test suite must pass without errors and warnings.
|
|
96
|
+
- Include unit tests. This project maintains 100% code coverage.
|
|
97
|
+
- If your changes add functionality, update the documentation accordingly.
|
|
98
|
+
|
|
99
|
+
Feel free to submit early, though—we can always iterate on this.
|
|
100
|
+
|
|
101
|
+
To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:
|
|
102
|
+
|
|
103
|
+
```console
|
|
104
|
+
$ nox --session=pre-commit -- install
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
It is recommended to open an issue before starting work on anything.
|
|
108
|
+
This will allow a chance to talk it over with the owners and validate your approach.
|
|
109
|
+
|
|
110
|
+
[pull request]: https://github.com/ylab-hi/scanitd/pulls
|
|
111
|
+
|
|
112
|
+
<!-- github-only -->
|
|
113
|
+
|
|
114
|
+
[code of conduct]: CODE_OF_CONDUCT.md
|
scanitd-0.9.2/Makefile
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
.PHONY: clean clean-build clean-pyc clean-test coverage dist docs help install lint lint/flake8
|
|
2
|
+
|
|
3
|
+
.DEFAULT_GOAL := help
|
|
4
|
+
|
|
5
|
+
define BROWSER_PYSCRIPT
|
|
6
|
+
import os, webbrowser, sys
|
|
7
|
+
|
|
8
|
+
from urllib.request import pathname2url
|
|
9
|
+
|
|
10
|
+
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
|
|
11
|
+
endef
|
|
12
|
+
export BROWSER_PYSCRIPT
|
|
13
|
+
|
|
14
|
+
define PRINT_HELP_PYSCRIPT
|
|
15
|
+
import re, sys
|
|
16
|
+
|
|
17
|
+
for line in sys.stdin:
|
|
18
|
+
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
|
|
19
|
+
if match:
|
|
20
|
+
target, help = match.groups()
|
|
21
|
+
print("%-20s %s" % (target, help))
|
|
22
|
+
endef
|
|
23
|
+
export PRINT_HELP_PYSCRIPT
|
|
24
|
+
|
|
25
|
+
BROWSER := python -c "$$BROWSER_PYSCRIPT"
|
|
26
|
+
|
|
27
|
+
help:
|
|
28
|
+
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
|
|
29
|
+
|
|
30
|
+
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
|
|
31
|
+
|
|
32
|
+
clean-build: ## remove build artifacts
|
|
33
|
+
rm -fr build/
|
|
34
|
+
rm -fr dist/
|
|
35
|
+
rm -fr .eggs/
|
|
36
|
+
find . -name '*.egg-info' -exec rm -fr {} +
|
|
37
|
+
find . -name '*.egg' -exec rm -f {} +
|
|
38
|
+
|
|
39
|
+
clean-pyc: ## remove Python file artifacts
|
|
40
|
+
find . -name '*.pyc' -exec rm -f {} +
|
|
41
|
+
find . -name '*.pyo' -exec rm -f {} +
|
|
42
|
+
find . -name '*~' -exec rm -f {} +
|
|
43
|
+
find . -name '__pycache__' -exec rm -fr {} +
|
|
44
|
+
|
|
45
|
+
clean-test: ## remove test and coverage artifacts
|
|
46
|
+
rm -fr .tox/
|
|
47
|
+
rm -f .coverage
|
|
48
|
+
rm -fr htmlcov/
|
|
49
|
+
rm -fr .pytest_cache
|
|
50
|
+
|
|
51
|
+
lint/flake8: ## check style with flake8
|
|
52
|
+
uv run flake8 src/scanitd tests
|
|
53
|
+
|
|
54
|
+
lint: lint/flake8 ## check style
|
|
55
|
+
|
|
56
|
+
test: ## run tests quickly with the default Python
|
|
57
|
+
uv run pytest
|
|
58
|
+
|
|
59
|
+
test-all: ## run tests on every Python version with tox
|
|
60
|
+
tox
|
|
61
|
+
|
|
62
|
+
coverage: ## check code coverage quickly with the default Python
|
|
63
|
+
uv run coverage run --source scanitd -m pytest
|
|
64
|
+
uv run coverage report -m
|
|
65
|
+
uv run coverage html
|
|
66
|
+
$(BROWSER) htmlcov/index.html
|
|
67
|
+
|
|
68
|
+
docs: ## generate Sphinx HTML documentation, including API docs
|
|
69
|
+
rm -f docs/scanitd.rst
|
|
70
|
+
rm -f docs/modules.rst
|
|
71
|
+
uv run sphinx-apidoc -o docs/ src/scanitd
|
|
72
|
+
$(MAKE) -C docs clean
|
|
73
|
+
$(MAKE) -C docs html
|
|
74
|
+
$(BROWSER) docs/_build/html/index.html
|
|
75
|
+
|
|
76
|
+
servedocs: docs ## compile the docs watching for changes
|
|
77
|
+
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
|
|
78
|
+
|
|
79
|
+
release: dist ## package and upload a release
|
|
80
|
+
uv run twine upload dist/*
|
|
81
|
+
|
|
82
|
+
dist: clean ## builds source and wheel package
|
|
83
|
+
uv build
|
|
84
|
+
ls -l dist
|
|
85
|
+
|
|
86
|
+
install: ## install the package into the active environment
|
|
87
|
+
uv sync
|
|
@@ -1,31 +1,35 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
2
|
Name: scanitd
|
|
3
|
-
Version: 0.9.
|
|
3
|
+
Version: 0.9.2
|
|
4
4
|
Summary: ScanITD
|
|
5
|
-
|
|
5
|
+
Project-URL: Homepage, https://github.com/ylab-hi/ScanITD
|
|
6
|
+
Project-URL: Repository, https://github.com/ylab-hi/ScanITD
|
|
7
|
+
Project-URL: Documentation, https://scanitd.readthedocs.io
|
|
8
|
+
Project-URL: Changelog, https://github.com/ylab-hi/ScanITD/releases
|
|
9
|
+
Author-email: Ting-You Wang <tywang@northwestern.edu>
|
|
6
10
|
License: MIT
|
|
7
|
-
|
|
8
|
-
Author-email: tywang@northwestern.edu
|
|
9
|
-
Requires-Python: >=3.9,<4.0
|
|
11
|
+
License-File: LICENSE
|
|
10
12
|
Classifier: Development Status :: 4 - Beta
|
|
11
|
-
Classifier:
|
|
12
|
-
Classifier: Programming Language :: Python :: 3
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
14
|
Classifier: Programming Language :: Python :: 3.10
|
|
15
15
|
Classifier: Programming Language :: Python :: 3.11
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.12
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
-
Requires-
|
|
19
|
-
Requires-Dist:
|
|
20
|
-
Requires-Dist:
|
|
21
|
-
Requires-Dist:
|
|
22
|
-
Requires-Dist:
|
|
23
|
-
Requires-Dist:
|
|
24
|
-
Requires-Dist:
|
|
25
|
-
Requires-Dist:
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Requires-Dist: loguru>=0.7.0
|
|
20
|
+
Requires-Dist: numpy>=2.0.0
|
|
21
|
+
Requires-Dist: psutil>=5.9.5
|
|
22
|
+
Requires-Dist: pyfaidx>=0.7.2
|
|
23
|
+
Requires-Dist: pysam>=0.22.0
|
|
24
|
+
Requires-Dist: rich>=13.7.0
|
|
25
|
+
Requires-Dist: ssw-py>=1.0.1
|
|
26
|
+
Requires-Dist: typer>=0.12.5
|
|
27
|
+
Provides-Extra: docs
|
|
28
|
+
Requires-Dist: myst-parser==3.0.0; extra == 'docs'
|
|
29
|
+
Requires-Dist: sphinx-autobuild>=2021.3.14; extra == 'docs'
|
|
30
|
+
Requires-Dist: sphinx-click>=6.0.0; extra == 'docs'
|
|
31
|
+
Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'docs'
|
|
32
|
+
Requires-Dist: sphinx>=7.2.6; extra == 'docs'
|
|
29
33
|
Description-Content-Type: text/markdown
|
|
30
34
|
|
|
31
35
|
# ScanITD
|
|
@@ -33,14 +37,36 @@ Description-Content-Type: text/markdown
|
|
|
33
37
|
[](https://pypi.python.org/pypi/scanitd)
|
|
34
38
|
[](https://pypi.org/project/scanitd/#files)
|
|
35
39
|
[](https://github.com/ylab-hi/ScanITD/blob/main/LICENSE)
|
|
40
|
+
[](https://scanitd.readthedocs.io)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
# 📦 Installation
|
|
36
44
|
|
|
37
|
-
|
|
45
|
+
ScanITD can be installed using pip, the Python package installer.
|
|
46
|
+
Follow these steps to install:
|
|
38
47
|
|
|
39
|
-
|
|
40
|
-
pip install scanitd
|
|
41
|
-
```
|
|
48
|
+
1. Ensure you have Python 3.10 or later installed on your system.
|
|
42
49
|
|
|
43
|
-
|
|
50
|
+
2. Create a virtual environment (recommended):
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
python -m venv scanitd_env
|
|
54
|
+
source scanitd_env/bin/activate # On Windows use `scanitd_env\Scripts\activate`
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
3. Install ScanITD:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
pip install scanitd
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
4. Verify the installation:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
scanitd --help
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
# 🛠️ Usage
|
|
44
70
|
|
|
45
71
|
Usage: scanitd [OPTIONS]
|
|
46
72
|
|
|
@@ -97,7 +123,6 @@ pip install scanitd
|
|
|
97
123
|
* `--version`, `-v`
|
|
98
124
|
- Show version and exit
|
|
99
125
|
|
|
100
|
-
# Citation
|
|
126
|
+
# 📚 Citation
|
|
101
127
|
|
|
102
128
|
Wang TY. and Yang R. [ScanITD: Detecting internal tandem duplication with robust variant allele frequency estimation](https://doi.org/10.1093/gigascience/giaa089 "ScanITD: Detecting internal tandem duplication with robust variant allele frequency estimation").
|
|
103
|
-
|