dlmachine 0.0.1__tar.gz

dlmachine-0.0.1/.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 0.0.1
+commit = True
+tag = True
+files = pyproject.toml
+
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
+serialize = {major}.{minor}.{patch}

dlmachine-0.0.1/.codecov.yaml

@@ -0,0 +1,17 @@
+# Based on pydata/xarray
+codecov:
+    require_ci_to_pass: no
+
+coverage:
+    status:
+        project:
+            default:
+                # Require 1% coverage, i.e., always succeed
+                target: 1
+        patch: false
+        changes: false
+
+comment:
+    layout: diff, flags, files
+    behavior: once
+    require_base: no

dlmachine-0.0.1/.coveragerc

@@ -0,0 +1,22 @@
+[paths]
+source =
+    download_manager
+    */site-packages/download-manager
+
+[run]
+branch = true
+parallel = true
+source = download_manager
+omit = */__init__.py
+
+[report]
+exclude_lines =
+    \#.*pragma:\s*no.?cover
+
+    if __name__ == .__main__.
+
+    ^\s*raise AssertionError\b
+    ^\s*raise NotImplementedError\b
+    ^\s*return NotImplemented\b
+show_missing = true
+precision = 2

dlmachine-0.0.1/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

dlmachine-0.0.1/.github/ISSUE_TEMPLATE/2-bug-report.yaml

@@ -0,0 +1,120 @@
+name: 🪳 Bug Report
+description: Create a report to help us reproduce and fix the bug
+
+title: "[BUG]: "
+labels:
+  - "bug"
+  - "triage"
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Before submitting a bug, please make sure the issue hasn't been already addressed by [searching through](https://github.com/saezlab/download-manager/issues).**
+        Please write your bug report in English to ensure it can be understood and addressed by the development team.
+
+  #----------------   Installed From --------------
+  - type: dropdown
+    id: source
+    attributes:
+      label: Source
+      description: download-manager has been installed from
+      options:
+        - conda
+        - pip
+        - uv
+        - poetry
+        - other (specify in text)
+    validations:
+      required: True
+
+  - type: input
+    id: source-other
+    attributes:
+      label: other source
+      placeholder: e.g., from source
+
+  #--------------   Python version   --------------
+  - type: input
+    id: Python
+    attributes:
+      label: Python version
+      placeholder: e.g., 3.10
+    validations:
+      required: true
+
+  #--------------   download-manager version   --------------
+  - type: input
+    id: download-manager-version
+    attributes:
+      label: download-manager version
+      placeholder: e.g., download-manager v0.0.1
+    validations:
+      required: true
+
+  #--------------   OS Platform and distribution   --------------
+  - type: input
+    id: OS
+    attributes:
+      label: OS platform and distribution
+      placeholder: e.g., Linux Ubuntu 16.04
+
+  #--------------   Describe the Bug   --------------
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: |
+        Please provide a clear and concise description of the bug.
+
+        If applicable, include a minimal example that allows us to reproduce the error by running the code.
+        It's crucial that the snippet is as short and focused as possible, so please remove any unnecessary code
+        to help us debug efficiently. We will copy and paste your code, and we expect to see the same result as you did.
+        Avoid using external data and make sure to include all relevant imports, etc. For example:
+
+        ```python
+        # All necessary imports at the beginning
+        import download_manager as dm
+
+        # A succinct reproducing example trimmed down to the essential parts:
+        manager = dm.DownloadManager()
+
+        ```
+
+        If the code is too lengthy (though we hope it's not), feel free to place it in a public gist and share the link in the issue: https://gist.github.com.
+
+        Instead of providing the expected results, please paste or describe the actual results you observe. If you encounter an error, include the error message along with the full traceback. It's helpful to wrap error messages in ```` ```triple quotes blocks``` ````.
+      placeholder: |
+        A clear and concise description of what the bug is.
+
+        ```python
+        # Sample code to reproduce the problem
+        ```
+
+        ```
+        The error message you got, with the full traceback.
+        ```
+    validations:
+      required: true
+
+  #--------------   Relevant LOG Output   --------------
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant LOG output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+
+  #--------------   Code of Conduct   --------------
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/download-manager/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
+
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for your contribution! 🎉 – Saezlab Team

dlmachine-0.0.1/.github/ISSUE_TEMPLATE/3-documentation-improvement.yaml

@@ -0,0 +1,58 @@
+name: 📔 Documentation Improvement
+description: Report wrong or missing documentation
+
+title: "[DOC]: "
+labels:
+  - "docs"
+  - "triage"
+projects: ["download-manager/1"]
+
+body:
+#----------------   Location of the documentation --------------
+  - type: textarea
+    id: location
+    attributes:
+      label: Location of the documentation
+      description: >
+        Please provide the location of the documentation. This could be a URL to the documentation page or a specific section within the documentation where you found the issue.
+         For example, if the issue is in the API reference, please provide the URL to that specific page. If it's in the README, please specify that as well.
+         If you're unsure about the exact location, please provide as much detail as possible to help us find it.
+         For example, you could say "The issue is in the API reference section under the 'DownloadManager' class" or "The issue is in the README under the 'Installation' section".
+      placeholder: readme, API reference, etc.
+    validations:
+      required: true
+
+#----------------   Problem Description --------------
+  - type: textarea
+    id: problem
+    attributes:
+      label: Documentation problem
+      description: >
+        Please provide a description of what documentation you believe needs to be fixed/improved
+    validations:
+      required: true
+
+#----------------   Suggested Fix  --------------
+  - type: textarea
+    id: suggested-fix
+    attributes:
+      label: Suggested fix for documentation
+      description: >
+        Please explain the suggested fix and **why** it's better than the existing documentation
+    validations:
+      required: true
+
+#--------------   Code of Conduct   --------------
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/download-manager/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
+
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for your contribution! 🎉 – Saezlab Team

dlmachine-0.0.1/.github/ISSUE_TEMPLATE/4-feature-request.yaml

@@ -0,0 +1,67 @@
+name: ✨ Feature Request
+description: Submit a proposal/request for a new download-manager feature
+
+title: "[FEAT]: "
+labels:
+  - "feature"
+projects: ["download-manager/1"]
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Note:** Please write your bug report in English to ensure it can be understood and addressed by the development team.
+
+  #--------------   Feature type    --------------
+  - type: dropdown
+    id: feature-type
+    attributes:
+      label: Feature Type
+      description: Please select what type of feature request you would like to propose.
+      options:
+        - Add new functionality to download-manager
+        - Change existing functionality in download-manager
+        - Remove existing functionality in download-manager
+      multiple: false
+    validations:
+      required: true
+
+  #--------------   Feature description and motivation    --------------
+  - type: textarea
+    attributes:
+      label: 🚀 The feature and motivation
+      description: >
+        Provide a clear and concise summary of the proposed feature, including the motivation behind it.
+        If your request addresses a specific problem, describe it (e.g., "I'm working on X and need Y to be achievable").
+        If this is connected to an existing GitHub issue, please include a link.
+      placeholder: |
+        **Feature description**
+          As user I want to be able to do X with download-manager so that I can achieve Y.
+
+        **Motivation**
+          This feature would be useful for Z because...
+
+    validations:
+      required: true
+
+  #--------------   Additional context    --------------
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >
+        Add any other context or screenshots about the feature request.
+
+  #--------------   Code of Conduct   --------------
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/download-manager/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
+
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for your contribution! 🎉 – Saezlab Team

dlmachine-0.0.1/.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,6 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 👥 download-manager GitHub Discussions
+    url: https://github.com/saezlab/download-manager/discussions
+    about: Please ask questions and participate in our long-term discussions here.
+

dlmachine-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,39 @@
+## Summary
+
+Describe the change in 1-3 concise points.
+
+## Related Issues
+
+- Closes #
+- Related to #
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Refactor / maintenance
+
+## What Changed
+
+- 
+
+## Validation
+
+- [ ] `poetry run pytest`
+- [ ] `poetry run flake8 download_manager`
+- [ ] Added/updated tests (if needed)
+- [ ] Added/updated documentation (if needed)
+
+## Breaking Changes
+
+- [ ] No breaking changes
+- [ ] Breaking changes (describe below)
+
+If there are breaking changes, describe migration steps:
+
+## Checklist
+
+- [ ] PR title is clear and descriptive
+- [ ] Scope is focused and minimal
+- [ ] No unrelated changes included

dlmachine-0.0.1/.github/workflows/build.yaml

@@ -0,0 +1,23 @@
+name: Package build
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    package:
+        runs-on: ubuntu-latest
+        steps:
+        -   uses: actions/checkout@v2
+        -   name: Set up Python 3.10
+            uses: actions/setup-python@v2
+            with:
+                python-version: '3.10'
+        -   name: Install build dependencies
+            run: python -m pip install --upgrade pip wheel twine build
+        -   name: Build package
+            run: python -m build
+        -   name: Check package
+            run: twine check --strict dist/*.whl

dlmachine-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: ci
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -e {0}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.10', '3.11', '3.12', '3.13', '3.14']
+        os: [ubuntu-latest, macos-latest]
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+      MODULE: download_manager
+
+    steps:
+    - name: Check out main
+      uses: actions/checkout@v4
+    - name: Setup Python ${{ matrix.python }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python }}
+    - name: System dependencies Linux
+      if: ${{ matrix.os == 'ubuntu-latest' }}
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libcurl4-openssl-dev
+    - name: System dependencies OSX
+      if: ${{ matrix.os == 'macos-latest' }}
+      run: |
+        brew install curl openssl
+        CURL_PREFIX="$(brew --prefix curl)"
+        SSL_PREFIX="$(brew --prefix openssl@3)"
+        {
+          echo "LDFLAGS=-L${SSL_PREFIX}/lib -L${CURL_PREFIX}/lib"
+          echo "CPPFLAGS=-I${SSL_PREFIX}/include -I${CURL_PREFIX}/include"
+          echo "PKG_CONFIG_PATH=${SSL_PREFIX}/lib/pkgconfig:${CURL_PREFIX}/lib/pkgconfig"
+          echo "PYCURL_SSL_LIBRARY=openssl"
+          echo "PYCURL_CURL_CONFIG=${CURL_PREFIX}/bin/curl-config"
+          echo "DYLD_LIBRARY_PATH=${CURL_PREFIX}/lib:${SSL_PREFIX}/lib"
+          echo "PIP_NO_BINARY=pycurl"
+        } >> "$GITHUB_ENV"
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.8.4
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        installer-parallel: true
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v4
+      with:
+        path: .venv
+        key: venv-${{ runner.os }}-${{ matrix.python }}-${{ hashFiles('**/poetry.lock') }}-v2
+    - name: Install dependencies
+      if: ${{ steps.cached-poetry-dependencies.outputs.cache-hit != 'true' }}
+      run: poetry install --no-interaction --no-root
+    - name: Install library
+      run: poetry install --no-interaction
+    - name: Rebuild pycurl from source on macOS
+      if: ${{ matrix.os == 'macos-latest' }}
+      run: "poetry run pip install --no-cache-dir --no-binary :all: --force-reinstall pycurl"
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        poetry run flake8 $MODULE --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        poetry run flake8 $MODULE --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Tests and test coverage
+      if: ${{ github.event_name == 'push' }}
+      run: |
+        poetry run pytest -v --cov --color=yes --durations=0 --disable-warnings
+    - name: Tests
+      if: ${{ github.event_name == 'pull_request' }}
+      run: |
+        poetry run pytest -v --color=yes --durations=0 --disable-warnings
+    - name: Upload coverage reports to Codecov
+      if: ${{ github.event_name == 'push' }}
+      env:
+        CODECOV_NAME: ${{ matrix.python }}-${{ matrix.os }}
+      run: |
+        poetry run codecovcli --verbose upload-process -t ${{ secrets.CODECOV_TOKEN }} -n 'std'-${{ github.run_id }}

dlmachine-0.0.1/.gitignore

@@ -0,0 +1,23 @@
+*~
+__pycache__/
+/build/
+/docs/_build/
+/docs/generated/
+.DS_Store
+/.vscode/
+/*.egg-info/
+*.egg
+*.prof
+*.coverage
+*.pickle
+/out/
+*.log
+/dist/
+*.pye
+*.pyc
+*.kate-swp
+/.tox/
+/.idea/
+/.pytest_cache/
+/.cache/
+/data/

dlmachine-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,110 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+fail_fast: false
+default_language_version:
+    python: python3
+default_stages:
+-   commit
+-   push
+minimum_pre_commit_version: 2.7.1
+repos:
+-   repo: https://github.com/deeenes/unexport
+    rev: 0.4.0-patch0-3
+    hooks:
+    -   id: unexport
+        args: [--refactor, --single_quotes]
+        exclude: __init__.py$
+-   repo: https://github.com/google/yapf
+    rev: v0.40.2
+    hooks:
+    -   id: yapf
+        additional_dependencies: [toml]
+        stages: [manual]
+-   repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+    -   id: black
+        additional_dependencies: [toml]
+        stages: [manual]
+-   repo: https://github.com/Instagram/Fixit
+    rev: 9d59f968e84bd2773f34b0069eeeaad3ce783254
+    hooks:
+    -   id: fixit-run-rules
+        stages: [manual]
+-   repo: https://github.com/timothycrosley/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+        additional_dependencies: [toml]
+-   repo: https://github.com/snok/pep585-upgrade
+    rev: v1.0
+    hooks:
+    -   id: upgrade-type-hints
+        args: [--futures=true]
+-   repo: https://github.com/asottile/add-trailing-comma
+    rev: v3.1.0
+    hooks:
+    -   id: add-trailing-comma
+-   repo: https://github.com/myint/unify
+    rev: v0.5
+    hooks:
+    -   id: unify
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: detect-private-key
+    -   id: check-ast
+    -   id: check-docstring-first
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+    -   id: mixed-line-ending
+        args: [--fix=lf]
+        exclude: ^docs/make.bat$
+    -   id: trailing-whitespace
+        exclude: ^.bumpversion.cfg$
+    -   id: check-merge-conflict
+    -   id: check-case-conflict
+    -   id: check-symlinks
+    -   id: check-yaml
+        args: [--unsafe]
+    -   id: check-ast
+    -   id: fix-encoding-pragma
+        args: [--remove] # for Python3 codebase, it's not necessary
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/john-hen/Flake8-pyproject
+    rev: 1.2.3
+    hooks:
+    -   id: Flake8-pyproject
+        additional_dependencies:
+        -   flake8-docstrings
+        -   flake8-comprehensions
+        -   flake8-bugbear
+        -   git+https://github.com/saezlab/flake8-kwargs-spaces.git
+-   repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.4
+    hooks:
+    -   id: rstcheck
+        exclude: docs
+-   repo: https://github.com/asottile/blacken-docs
+    rev: 1.18.0
+    hooks:
+    -   id: blacken-docs
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.17.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py3-plus, --py38-plus, --keep-runtime-typing]
+-   repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+    rev: v2.14.0
+    hooks:
+    -   id: pretty-format-yaml
+        args: [--autofix, --indent, '4']
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+    -   id: python-no-eval
+    -   id: python-use-type-annotations
+    -   id: python-check-blanket-noqa
+    -   id: rst-backticks
+    -   id: rst-directive-colons
+    -   id: rst-inline-touching-normal

dlmachine-0.0.1/.readthedocs.yaml

@@ -0,0 +1,22 @@
+version: 2
+
+sphinx:
+    builder: html
+    configuration: docs/source/conf.py
+    fail_on_warning: true
+
+formats:
+-   htmlzip
+-   pdf
+
+build:
+    os: ubuntu-22.04
+    tools:
+        python: 3.10
+
+python:
+    install:
+    -   method: pip
+        path: .
+        extra_requirements:
+        -   docs