alphapepttools 0.4.0__tar.gz → 0.4.1.dev0__tar.gz

{alphapepttools-0.4.0 → alphapepttools-0.4.1.dev0}/.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "0.4.0"
+current_version = "0.4.1-dev0"
 parse = """(?x)
     (?P<major>0|[1-9]\\d*)\\.
     (?P<minor>0|[1-9]\\d*)\\.

{alphapepttools-0.4.0 → alphapepttools-0.4.1.dev0}/.github/workflows/test.yaml

@@ -91,4 +91,4 @@ jobs:
         run: |
           coverage report
       - name: Upload coverage
-        uses: codecov/codecov-action@v7.0.0
+        uses: codecov/codecov-action@v7.1.1

{alphapepttools-0.4.0 → alphapepttools-0.4.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: alphapepttools
-Version: 0.4.0
+Version: 0.4.1-dev0
 Summary: Search- and quantification-engine agnostic biological interpretation of proteomics data
 Project-URL: Documentation, https://alphapepttools.readthedocs.io/
 Project-URL: Homepage, https://github.com/MannLabs/alphapepttools
@@ -276,12 +276,17 @@ Description-Content-Type: text/markdown
 ![PyPI - Version](https://img.shields.io/pypi/v/alphapepttools)
 [![Tests][badge-tests]][tests]
 [![Documentation][badge-docs]][documentation]
+[![Preprint][badge-preprint]][preprint]
 
 [badge-tests]: https://img.shields.io/github/actions/workflow/status/MannLabs/alphapepttools/test.yaml?branch=main
 [badge-docs]: https://github.com/MannLabs/alphapepttools/actions/workflows/docs.yaml/badge.svg
+[badge-preprint]: https://img.shields.io/badge/preprint-bioRxiv-b31b1b
 
 Search- and quantification-engine agnostic downstream processing of proteomics data
 
+> [!TIP]
+> Our [preprint is out now][preprint]!
+
 ## `alphapepttools` was made to make your life in proteomics easier!
 
 Functionalities are intended to be as close to pure python as possible, avoiding closed end-to-end implementations, which is reflected in several design choices:
@@ -307,7 +312,7 @@ in particular, the [API documentation][].
 
 ## Installation
 
-You need to have Python 3.11 or newer installed on your system.
+You need to have Python 3.11 or newer installed on your system (Linux/MacOS/Windows).
 If you don't have Python installed, we recommend installing [Mambaforge][].
 
 There are several alternative options to install alphapepttools:
@@ -326,6 +331,9 @@ As the package is still under development, consider installing the latest develo
 pip install git+https://github.com/MannLabs/alphapepttools.git@main
 ```
 
+For a full list of dependencies, see the dependencies section in the [pyproject.toml](pyproject.toml).
+Installation should take less than 5 minutes.
+
 ### Installation extras
 
 Depending on your use case, you might want to install specific versions of packages or additional dependencies.
@@ -382,12 +390,14 @@ If you found a bug, please use the [issue tracker][].
 
 ## Citation
 
-> t.b.a
+> Brennsteiner, V., Diedrich, L. et al.
+> [_AlphaPeptTools: scverse-native analysis of mass spectrometry-based proteomics_][preprint] (preprint), bioRxiv (2026).
 
 [mambaforge]: https://github.com/conda-forge/miniforge#mambaforge
 [scverse discourse]: https://discourse.scverse.org/
 [issue tracker]: https://github.com/MannLabs/alphapepttools/issues
 [tests]: https://github.com/MannLabs/alphapepttools/actions/workflows/test.yml
+[preprint]: https://www.biorxiv.org/content/10.64898/2026.09.11.750886v1
 
 <!-- TODO: Change documentation pages back to readthedocs upon public release -->
 <!-- [documentation]: https://alphapepttools.readthedocs.io -->

{alphapepttools-0.4.0 → alphapepttools-0.4.1.dev0}/README.md

@@ -3,12 +3,17 @@
 ![PyPI - Version](https://img.shields.io/pypi/v/alphapepttools)
 [![Tests][badge-tests]][tests]
 [![Documentation][badge-docs]][documentation]
+[![Preprint][badge-preprint]][preprint]
 
 [badge-tests]: https://img.shields.io/github/actions/workflow/status/MannLabs/alphapepttools/test.yaml?branch=main
 [badge-docs]: https://github.com/MannLabs/alphapepttools/actions/workflows/docs.yaml/badge.svg
+[badge-preprint]: https://img.shields.io/badge/preprint-bioRxiv-b31b1b
 
 Search- and quantification-engine agnostic downstream processing of proteomics data
 
+> [!TIP]
+> Our [preprint is out now][preprint]!
+
 ## `alphapepttools` was made to make your life in proteomics easier!
 
 Functionalities are intended to be as close to pure python as possible, avoiding closed end-to-end implementations, which is reflected in several design choices:
@@ -34,7 +39,7 @@ in particular, the [API documentation][].
 
 ## Installation
 
-You need to have Python 3.11 or newer installed on your system.
+You need to have Python 3.11 or newer installed on your system (Linux/MacOS/Windows).
 If you don't have Python installed, we recommend installing [Mambaforge][].
 
 There are several alternative options to install alphapepttools:
@@ -53,6 +58,9 @@ As the package is still under development, consider installing the latest develo
 pip install git+https://github.com/MannLabs/alphapepttools.git@main
 ```
 
+For a full list of dependencies, see the dependencies section in the [pyproject.toml](pyproject.toml).
+Installation should take less than 5 minutes.
+
 ### Installation extras
 
 Depending on your use case, you might want to install specific versions of packages or additional dependencies.
@@ -109,12 +117,14 @@ If you found a bug, please use the [issue tracker][].
 
 ## Citation
 
-> t.b.a
+> Brennsteiner, V., Diedrich, L. et al.
+> [_AlphaPeptTools: scverse-native analysis of mass spectrometry-based proteomics_][preprint] (preprint), bioRxiv (2026).
 
 [mambaforge]: https://github.com/conda-forge/miniforge#mambaforge
 [scverse discourse]: https://discourse.scverse.org/
 [issue tracker]: https://github.com/MannLabs/alphapepttools/issues
 [tests]: https://github.com/MannLabs/alphapepttools/actions/workflows/test.yml
+[preprint]: https://www.biorxiv.org/content/10.64898/2026.09.11.750886v1
 
 <!-- TODO: Change documentation pages back to readthedocs upon public release -->
 <!-- [documentation]: https://alphapepttools.readthedocs.io -->

alphapepttools-0.4.1.dev0/docs/_static/logo/alphapepttools.svg

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="stripes" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 283.46 283.46">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: none;
+      }
+
+      .cls-2 {
+        fill: #42c4ec;
+      }
+
+      .cls-3 {
+        fill: #eaecb3;
+      }
+
+      .cls-4 {
+        fill: #17232c;
+      }
+
+      .cls-5 {
+        clip-path: url(#clippath-1);
+      }
+
+      .cls-6 {
+        clip-path: url(#clippath-2);
+      }
+
+      .cls-7 {
+        fill: #86ccac;
+      }
+
+      .cls-8 {
+        fill: #d7d7d7;
+      }
+
+      .cls-9 {
+        fill: #63c6cf;
+      }
+
+      .cls-10 {
+        clip-path: url(#clippath);
+      }
+    </style>
+    <clipPath id="clippath">
+      <rect id="rectangle-2" data-name="rectangle" class="cls-1" x="0" y=".26" width="282.95" height="282.95" rx="31.44" ry="31.44"/>
+    </clipPath>
+    <clipPath id="clippath-1">
+      <rect id="rectangle-3" data-name="rectangle" class="cls-1" x="0" y=".26" width="282.95" height="282.95" rx="31.44" ry="31.44"/>
+    </clipPath>
+    <clipPath id="clippath-2">
+      <path id="rectangle-4" data-name="rectangle" class="cls-1" d="M282.95,121.64v130.12c0,17.36-14.08,31.44-31.44,31.44H31.44C14.08,283.21,0,269.13,0,251.77V31.7C0,14.33,14.08.26,31.44.26h220.07c17.36,0,31.44,14.08,31.44,31.44v89.95"/>
+    </clipPath>
+  </defs>
+  <rect id="rectangle" class="cls-4" x="0" y=".26" width="282.95" height="282.95" rx="31.44" ry="31.44"/>
+  <g>
+    <path class="cls-8" d="M35.78,169.17l13.92,35.64h-5.24l-3.89-10.73h-15.07l-3.99,10.73h-4.84l13.87-35.64h5.24ZM39.08,190.09l-5.94-16.62h-.1l-6.04,16.62h12.08Z"/>
+    <path class="cls-8" d="M56.99,169.17v35.64h-4.24v-35.64h4.24Z"/>
+    <path class="cls-8" d="M67.97,179.01v3.49h.1c.7-1.43,1.8-2.47,3.29-3.12,1.5-.65,3.14-.97,4.94-.97,2,0,3.73.37,5.22,1.1,1.48.73,2.71,1.72,3.69,2.97.98,1.25,1.72,2.69,2.22,4.32.5,1.63.75,3.36.75,5.19s-.24,3.56-.72,5.19c-.48,1.63-1.21,3.05-2.2,4.27-.98,1.21-2.21,2.17-3.69,2.87-1.48.7-3.2,1.05-5.17,1.05-.63,0-1.34-.07-2.12-.2-.78-.13-1.56-.35-2.32-.65-.77-.3-1.49-.71-2.17-1.22-.68-.52-1.26-1.16-1.72-1.92h-.1v13.28h-4.24v-35.63h4.24ZM83.22,188.17c-.32-1.15-.8-2.17-1.45-3.07s-1.48-1.61-2.5-2.15c-1.02-.53-2.2-.8-3.57-.8-1.43,0-2.65.28-3.64.85-1,.57-1.81,1.31-2.45,2.22-.63.92-1.09,1.96-1.37,3.12-.28,1.17-.42,2.35-.42,3.54,0,1.26.15,2.49.45,3.67s.77,2.22,1.42,3.12,1.49,1.62,2.52,2.17c1.03.55,2.28.82,3.74.82s2.69-.28,3.67-.85c.98-.57,1.77-1.31,2.37-2.25s1.03-2,1.3-3.19c.27-1.2.4-2.43.4-3.69,0-1.2-.16-2.37-.47-3.52Z"/>
+    <path class="cls-8" d="M97.42,169.17v13.63h.1c.33-.8.8-1.47,1.4-2.02.6-.55,1.27-1,2.02-1.35s1.53-.61,2.35-.77c.81-.17,1.6-.25,2.37-.25,1.7,0,3.11.23,4.24.7,1.13.47,2.05,1.12,2.74,1.95.7.83,1.19,1.82,1.47,2.97.28,1.15.42,2.42.42,3.82v16.97h-4.24v-17.47c0-1.6-.47-2.86-1.4-3.79-.93-.93-2.21-1.4-3.84-1.4-1.3,0-2.42.2-3.37.6-.95.4-1.74.96-2.37,1.7-.63.73-1.11,1.59-1.42,2.57-.32.98-.47,2.05-.47,3.22v14.57h-4.24v-35.64h4.24Z"/>
+    <path class="cls-8" d="M143.79,204.71c-.73.43-1.75.65-3.05.65-1.1,0-1.97-.31-2.62-.92-.65-.62-.97-1.62-.97-3.02-1.16,1.4-2.52,2.4-4.07,3.02-1.55.62-3.22.92-5.02.92-1.17,0-2.27-.13-3.32-.4-1.05-.27-1.96-.68-2.72-1.25-.77-.57-1.37-1.31-1.82-2.22-.45-.91-.67-2.02-.67-3.32,0-1.46.25-2.66.75-3.59.5-.93,1.16-1.69,1.97-2.27.81-.58,1.75-1.02,2.79-1.32,1.05-.3,2.12-.55,3.22-.75,1.17-.23,2.27-.41,3.32-.52,1.05-.12,1.97-.28,2.77-.5.8-.22,1.43-.53,1.9-.95s.7-1.02.7-1.82c0-.93-.18-1.68-.52-2.25-.35-.57-.8-1-1.35-1.3s-1.17-.5-1.85-.6c-.68-.1-1.36-.15-2.02-.15-1.8,0-3.29.34-4.49,1.02-1.2.68-1.85,1.97-1.95,3.87h-4.24c.07-1.6.4-2.95,1-4.04.6-1.1,1.4-1.99,2.4-2.67,1-.68,2.14-1.17,3.42-1.47,1.28-.3,2.65-.45,4.12-.45,1.16,0,2.32.08,3.47.25s2.19.51,3.12,1.02,1.68,1.24,2.25,2.17c.56.93.85,2.14.85,3.63v13.25c0,1,.06,1.73.18,2.19.12.46.51.7,1.17.7.37,0,.8-.07,1.3-.2v3.29ZM136.9,191.48c-.53.4-1.23.69-2.1.87s-1.77.33-2.72.45c-.95.12-1.9.25-2.87.4-.97.15-1.83.39-2.6.72-.77.33-1.39.8-1.87,1.42-.48.61-.72,1.45-.72,2.51,0,.7.14,1.28.42,1.76.28.48.65.87,1.1,1.17s.97.51,1.57.65c.6.13,1.23.2,1.9.2,1.4,0,2.6-.19,3.59-.57,1-.38,1.81-.86,2.45-1.44.63-.58,1.1-1.21,1.4-1.89.3-.68.45-1.32.45-1.91v-4.32Z"/>
+    <path class="cls-8" d="M164.05,169.17c3.59,0,6.31.92,8.16,2.77s2.77,4.43,2.77,7.76-.92,5.92-2.77,7.79-4.57,2.78-8.16,2.75h-10.88v14.57h-4.74v-35.64h15.62ZM162.45,186.24c2.69.03,4.67-.52,5.91-1.65,1.25-1.13,1.87-2.76,1.87-4.89s-.62-3.75-1.87-4.87c-1.25-1.11-3.22-1.67-5.91-1.67h-9.28v13.08h9.28Z"/>
+    <path class="cls-8" d="M198.34,203.16c-1.93,1.46-4.36,2.2-7.29,2.2-2.06,0-3.85-.33-5.37-1s-2.79-1.6-3.82-2.79c-1.03-1.2-1.81-2.63-2.32-4.29s-.81-3.48-.87-5.44c0-1.96.3-3.76.9-5.39s1.44-3.04,2.52-4.24c1.08-1.2,2.36-2.13,3.84-2.79,1.48-.67,3.1-1,4.87-1,2.3,0,4.2.47,5.71,1.42,1.51.95,2.73,2.15,3.64,3.62.91,1.46,1.55,3.06,1.9,4.79.35,1.73.49,3.38.42,4.94h-19.31c-.03,1.13.1,2.2.4,3.22.3,1.02.78,1.91,1.45,2.7.67.78,1.51,1.41,2.55,1.87,1.03.47,2.25.7,3.64.7,1.8,0,3.27-.42,4.42-1.25,1.15-.83,1.9-2.1,2.27-3.79h4.19c-.57,2.9-1.81,5.08-3.74,6.54ZM197.31,186.59c-.38-.9-.9-1.67-1.55-2.32s-1.41-1.16-2.3-1.55c-.88-.38-1.86-.57-2.92-.57s-2.09.19-2.97.57c-.88.38-1.64.91-2.27,1.57-.63.67-1.13,1.44-1.5,2.32-.37.88-.58,1.82-.65,2.82h14.82c-.07-1-.29-1.95-.67-2.84Z"/>
+    <path class="cls-8" d="M211.26,179.01v3.49h.1c.7-1.43,1.8-2.47,3.29-3.12,1.5-.65,3.14-.97,4.94-.97,2,0,3.74.37,5.22,1.1s2.71,1.72,3.69,2.97c.98,1.25,1.72,2.69,2.22,4.32.5,1.63.75,3.36.75,5.19s-.24,3.56-.72,5.19c-.48,1.63-1.21,3.05-2.2,4.27-.98,1.21-2.21,2.17-3.69,2.87-1.48.7-3.2,1.05-5.17,1.05-.63,0-1.34-.07-2.12-.2-.78-.13-1.56-.35-2.32-.65-.77-.3-1.49-.71-2.17-1.22-.68-.52-1.26-1.16-1.72-1.92h-.1v13.28h-4.24v-35.63h4.24ZM226.51,188.17c-.32-1.15-.8-2.17-1.45-3.07-.65-.9-1.48-1.61-2.5-2.15-1.02-.53-2.2-.8-3.57-.8s-2.65.28-3.64.85c-1,.57-1.81,1.31-2.45,2.22-.63.92-1.09,1.96-1.37,3.12s-.42,2.35-.42,3.54c0,1.26.15,2.49.45,3.67s.77,2.22,1.42,3.12c.65.9,1.49,1.62,2.52,2.17s2.28.82,3.74.82,2.69-.28,3.67-.85c.98-.57,1.77-1.31,2.37-2.25.6-.93,1.03-2,1.3-3.19.27-1.2.4-2.43.4-3.69,0-1.2-.16-2.37-.47-3.52Z"/>
+    <path class="cls-8" d="M247.5,179.01v3.74h-5.14v16.02c0,.5.04.9.12,1.2.08.3.24.53.47.7.23.17.56.27.97.32s.96.08,1.62.08h1.95v3.74h-3.24c-1.1,0-2.04-.08-2.82-.22-.78-.15-1.42-.42-1.9-.82-.48-.4-.84-.96-1.07-1.7-.23-.73-.35-1.7-.35-2.89v-16.42h-4.39v-3.74h4.39v-7.74h4.24v7.74h5.14Z"/>
+    <path class="cls-8" d="M17.07,233.06v-3.99h28.5v3.99h-11.88v31.64h-4.74v-31.64h-11.88Z"/>
+    <path class="cls-8" d="M42.67,246.51c.53-1.65,1.33-3.08,2.4-4.29,1.06-1.21,2.38-2.17,3.94-2.87,1.56-.7,3.36-1.05,5.39-1.05s3.87.35,5.42,1.05c1.55.7,2.85,1.66,3.92,2.87,1.06,1.21,1.86,2.65,2.4,4.29.53,1.65.8,3.42.8,5.32s-.27,3.66-.8,5.29c-.53,1.63-1.33,3.05-2.4,4.27-1.07,1.22-2.37,2.16-3.92,2.84-1.55.68-3.35,1.02-5.42,1.02s-3.83-.34-5.39-1.02c-1.56-.68-2.88-1.63-3.94-2.84-1.06-1.21-1.86-2.64-2.4-4.27-.53-1.63-.8-3.39-.8-5.29s.27-3.67.8-5.32ZM46.99,255.99c.42,1.21.99,2.23,1.72,3.04.73.82,1.59,1.44,2.57,1.87.98.43,2.02.65,3.12.65s2.14-.22,3.12-.65c.98-.43,1.84-1.06,2.57-1.87.73-.81,1.31-1.83,1.72-3.04s.62-2.6.62-4.17-.21-2.95-.62-4.17c-.42-1.21-.99-2.24-1.72-3.07-.73-.83-1.59-1.46-2.57-1.9-.98-.43-2.02-.65-3.12-.65s-2.14.22-3.12.65c-.98.43-1.84,1.06-2.57,1.9-.73.83-1.31,1.86-1.72,3.07-.42,1.21-.62,2.6-.62,4.17s.21,2.95.62,4.17Z"/>
+    <path class="cls-8" d="M71.32,246.51c.53-1.65,1.33-3.08,2.4-4.29,1.06-1.21,2.38-2.17,3.94-2.87,1.56-.7,3.36-1.05,5.39-1.05s3.87.35,5.42,1.05c1.55.7,2.85,1.66,3.92,2.87,1.06,1.21,1.86,2.65,2.4,4.29.53,1.65.8,3.42.8,5.32s-.27,3.66-.8,5.29c-.53,1.63-1.33,3.05-2.4,4.27-1.07,1.22-2.37,2.16-3.92,2.84-1.55.68-3.35,1.02-5.42,1.02s-3.83-.34-5.39-1.02c-1.56-.68-2.88-1.63-3.94-2.84-1.06-1.21-1.86-2.64-2.4-4.27-.53-1.63-.8-3.39-.8-5.29s.27-3.67.8-5.32ZM75.63,255.99c.42,1.21.99,2.23,1.72,3.04.73.82,1.59,1.44,2.57,1.87.98.43,2.02.65,3.12.65s2.14-.22,3.12-.65c.98-.43,1.84-1.06,2.57-1.87.73-.81,1.31-1.83,1.72-3.04s.62-2.6.62-4.17-.21-2.95-.62-4.17c-.42-1.21-.99-2.24-1.72-3.07-.73-.83-1.59-1.46-2.57-1.9-.98-.43-2.02-.65-3.12-.65s-2.14.22-3.12.65c-.98.43-1.84,1.06-2.57,1.9-.73.83-1.31,1.86-1.72,3.07-.42,1.21-.62,2.6-.62,4.17s.21,2.95.62,4.17Z"/>
+    <path class="cls-8" d="M105.06,229.07v35.64h-4.24v-35.64h4.24Z"/>
+    <path class="cls-8" d="M114.89,258.94c.4.65.92,1.17,1.57,1.55.65.38,1.38.66,2.2.82.81.17,1.65.25,2.52.25.67,0,1.36-.05,2.1-.15.73-.1,1.41-.28,2.02-.55s1.12-.66,1.52-1.17.6-1.17.6-1.97c0-1.1-.42-1.93-1.25-2.5-.83-.57-1.87-1.02-3.12-1.37-1.25-.35-2.6-.67-4.07-.95-1.46-.28-2.82-.68-4.07-1.2-1.25-.52-2.29-1.24-3.12-2.17-.83-.93-1.25-2.23-1.25-3.89,0-1.3.29-2.41.87-3.34.58-.93,1.33-1.69,2.25-2.27.92-.58,1.95-1.01,3.09-1.3,1.15-.28,2.29-.42,3.42-.42,1.46,0,2.81.12,4.04.38,1.23.25,2.32.68,3.27,1.3.95.62,1.7,1.45,2.27,2.5.57,1.05.9,2.35,1,3.92h-4.24c-.07-.83-.28-1.52-.65-2.07-.37-.55-.83-.99-1.4-1.32-.57-.33-1.19-.57-1.87-.72-.68-.15-1.37-.22-2.07-.22-.63,0-1.27.05-1.92.15-.65.1-1.24.27-1.77.52-.53.25-.97.58-1.3,1-.33.42-.5.96-.5,1.62,0,.73.26,1.34.77,1.82.52.48,1.17.88,1.97,1.2.8.32,1.7.58,2.7.8,1,.22,2,.44,2.99.67,1.06.23,2.1.52,3.12.85,1.01.33,1.91.77,2.7,1.32.78.55,1.41,1.24,1.9,2.07.48.83.72,1.86.72,3.09,0,1.56-.32,2.86-.97,3.89-.65,1.03-1.5,1.86-2.55,2.5-1.05.63-2.23,1.07-3.54,1.32-1.31.25-2.62.37-3.92.37-1.43,0-2.79-.15-4.09-.45-1.3-.3-2.45-.79-3.44-1.47-1-.68-1.8-1.58-2.4-2.7-.6-1.11-.93-2.47-1-4.07h4.24c.03.93.25,1.72.65,2.37Z"/>
+  </g>
+  <g>
+    <polyline class="cls-3" points="282.95 121.64 261.77 142.83 217.3 98.37 283.46 32.21"/>
+    <line class="cls-3" x1="283.46" y1="32.21" x2="282.95" y2="121.64"/>
+    <g class="cls-10">
+      <rect class="cls-2" x="-30" y=".24" width="251.51" height="62.88" transform="translate(5.65 76.99) rotate(-45)"/>
+    </g>
+    <g class="cls-5">
+      <rect class="cls-7" x="80.05" y=".24" width="251.51" height="62.88" transform="translate(37.88 154.8) rotate(-45)"/>
+    </g>
+    <g class="cls-6">
+      <rect class="cls-9" x="-144.31" y=".24" width="251.51" height="62.88" transform="translate(-27.83 -3.84) rotate(-45)"/>
+    </g>
+  </g>
+</svg>