gitlab-activity 0.1.0__tar.gz

gitlab_activity-0.1.0/.gitignore

@@ -0,0 +1,112 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage*.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+.ruff_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Docs tmp files
+docs/tags_list.txt
+
+# All node and npm related stuff
+**/node_modules
+**/.yarn

gitlab_activity-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,267 @@
+image: python:3.12-bullseye
+
+stages:
+  - pretest
+  - build
+  - test
+  - pre-release
+  - deploy
+  - release
+
+# Global variables for release jobs
+variables:
+  VERSION: minor
+  BRANCH: main
+
+# Create an anchor to setup node
+.setup_node:
+  before_script:
+    - pip install -U pip
+    # Install nodejs
+    - wget https://nodejs.org/dist/v18.12.1/node-v18.12.1-linux-x64.tar.xz
+    - tar -xvf node-v18.12.1-linux-x64.tar.xz
+    - mv node-v18.12.1-linux-x64 /root/nodejs
+    - rm -rf node-v18.12.1-linux-x64.tar.xz
+    - export PATH=/root/nodejs/bin:$PATH
+    - npm --version
+
+# Anchor for setting up prepare_release job
+.setup_prepare_release:
+  before_script:
+    - echo "Preparing release..."
+    # Install hatch and install package
+    - pip install git+https://github.com/pypa/hatch
+    - pip install -e '.[dev]'
+
+# Anchor with reference for prepare_release job.
+# We will test it in CI as well without actually pushing
+# the commits. So we reference the anchor to avoid duplication
+.prepare_release: &prepare_release
+  # Check out correct branch
+  # By default a shallow clone is made in CI. So first fetch from origin
+  # and then checkout if branch is other than main
+  - |
+    if [[ ${BRANCH} != "main" ]]; then
+        git fetch origin ${BRANCH}
+        git checkout ${BRANCH}
+    fi
+  # Bump version
+  - hatch version ${VERSION}
+  # Get new version
+  - export NEXT_VERSION_SPECIFIER=$(hatch version)
+  # Generate changelog
+  - gitlab-activity --append -o CHANGELOG.md
+  - cat CHANGELOG.md
+  - git add CHANGELOG.md gitlab_activity/_version.py
+  # Run pre-commit to auto format files
+  - pre-commit install
+  - pre-commit run --all-files || true
+  # Configure mail and name of the user who should be visible in the commit history
+  - git config --global user.email 'release-bot@gitlab.com'
+  - git config --global user.name 'Release Bot'
+  # Dont run pre-commit here
+  - git commit -m "Bump version to ${NEXT_VERSION_SPECIFIER} & update CHANGELOG.md" --no-verify
+  # Create new tag
+  - git tag ${NEXT_VERSION_SPECIFIER} -m "Release ${NEXT_VERSION_SPECIFIER}"
+
+# Pre commit tests
+pre-commit:
+  stage: pretest
+  script:
+    - mkdir -p build/reports
+    - pip install pre-commit
+    - pre-commit install
+    - pre-commit run --all-files --show-diff-on-failure
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Test to build package
+build-test:
+  stage: build
+  script:
+    - pip install .
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Test to build docs
+build-doc:
+  stage: build
+  extends: .setup_node
+  script:
+    - pip install git+https://github.com/pypa/hatch
+    - hatch run docs:build
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Unit and functional tests
+tests:
+  stage: test
+  parallel:
+    matrix:
+      - PYVER: ["3.8", "3.9", "3.10", "3.11"]
+  script:
+    # Install hatch first. Install it from Git until
+    # a release with [PR#1002](https://github.com/pypa/hatch/pull/1002)
+    # is made
+    - pip install git+https://github.com/pypa/hatch
+    # Checks the current python version
+    - hatch run +py=$PYVER test:check
+    # Runs tests
+    - hatch run +py=$PYVER test:test
+    # Codecov specific stuff
+    - curl -Os https://uploader.codecov.io/latest/linux/codecov
+    - chmod +x codecov
+    # Seems like we need to add HTTP Proxy explicitly
+    # Add coverage report only for one version
+    - ./codecov -t $CODECOV_TOKEN -U $HTTPS_PROXY -f coverage.xml -F py$PYVER
+  after_script:
+    - cp coverage.xml build/reports/
+  coverage: '/TOTAL\s+\d+\s+\d+\s+\d+\s+\d+\s+(\d+)%/'
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Test to check release steps
+test-release:
+  stage: pre-release
+  extends: .setup_prepare_release
+  # We do clone for this test as cached repos might have existing
+  # tags that can fail the job.
+  variables:
+    GIT_STRATEGY: clone
+  script:
+    - *prepare_release
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Test to check publish steps with local PyPi server
+test-publish:
+  stage: pre-release
+  needs:
+    - test-release
+  before_script:
+    # Install prerequisites
+    - pip install git+https://github.com/pypa/hatch
+  script:
+    # Build package
+    - hatch run publish:build-package
+    # Check dist files
+    - hatch run publish:check-package
+    # Start a test pypi server
+    - hatch run publish:start-localpypi &
+    # Sleep for a while for server to start
+    - sleep 30
+    # Upload package to test
+    - hatch run publish:upload-to-localpypi
+  artifacts:
+    paths:
+      - build/reports/
+    expire_in: 1 day
+  except:
+    - tags
+
+# Generate and deploy docs
+pages:
+  stage: deploy
+  extends: .setup_node
+  script:
+    - pip install git+https://github.com/pypa/hatch
+    - hatch run docs:build
+    - mv docs/website/build/ public/
+  artifacts:
+    paths:
+      - public
+  only:
+    - main
+  except:
+    - tags
+
+# Create a new release on GitLab UI
+release:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  script:
+    - echo "Running release job"
+  release:
+    name: "Release File $CI_COMMIT_TAG"
+    description: "Created using the GitLab's release-cli"
+    tag_name: $CI_COMMIT_TAG
+    ref: $CI_COMMIT_TAG
+  only:
+    - tags
+
+# Prepare release by tagging and adding entry to changelog
+prepare_release:
+  stage: release
+  when: manual
+  # We do clone for this test as cached repos might have existing
+  # tags that can fail the job
+  variables:
+    GIT_STRATEGY: clone
+  extends: .setup_prepare_release
+  script:
+    - *prepare_release
+    # Set remote push URL and push to originating branch
+    - git remote set-url --push origin "https://${GITLAB_CI_USER}:${GITLAB_CI_TOKEN}@${CI_REPOSITORY_URL#*@}"
+    - git push origin HEAD:${CI_COMMIT_REF_NAME} -o ci.skip # Pushes to the same branch as the trigger
+    - git push origin ${NEXT_VERSION_SPECIFIER} # Pushes the tag BUT triggers the CI to run tagged jobs
+  # Only run on main branch and do not run on tags
+  # Because we create tag in this job
+  only:
+    - main
+  except:
+    - tags
+
+# Publish the release to PyPI
+# This job first publishes to test server and then publish to
+# PyPI server upstream
+# NOTE: Before we were attempting to run this on tags job. This
+# WONT WORK as protected variables are ONLY available on
+# PROTECTED TAGS. So we need to run this job on default protected
+# branch
+publish:
+  stage: release
+  needs:
+    - prepare_release
+  # Use clone strategy to be able to checkout "latest" main
+  variables:
+    GIT_STRATEGY: clone
+  before_script:
+    - echo "Preparing publish job..."
+    # This is crucial. If not the commit we made from previous job
+    # will not be available here as CI will always checkout the commit
+    # that triggered the job
+    - git fetch origin main
+    - git checkout main
+    # Install prerequisites
+    - pip install git+https://github.com/pypa/hatch
+  script:
+    # Build package
+    - hatch run publish:build-package
+    # Check dist files
+    - hatch run publish:check-package
+    # Upload package to test
+    - hatch run publish:upload-to-pypi
+  only:
+    - main
+  except:
+    - tags

gitlab_activity-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+# pre-commit is a tool to perform a predefined set of tasks manually and/or
+# automatically before git commits are made.
+#
+# Config reference: https://pre-commit.com/#pre-commit-configyaml---top-level
+#
+# Common tasks
+#
+# - Run on all files:   pre-commit run --all-files
+# - Register git hooks: pre-commit install --install-hooks
+#
+# Exclude CHANGELOG.md as it can "sometimes" block release process
+# exclude: "CHANGELOG.md"
+repos:
+  # Autoformat: Python code
+  - repo: https://github.com/ambv/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+
+  # Autoformat: markdown, yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        exclude: tests/.*
+
+  # Autoformat: https://github.com/asottile/reorder_python_imports
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.9.0
+    hooks:
+      - id: reorder-python-imports
+
+  # Misc...
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      # Autoformat: Makes sure files end in a newline and only a newline.
+      - id: end-of-file-fixer
+        exclude: tests/.*
+
+      # Autoformat: Sorts entries in requirements.txt.
+      - id: requirements-txt-fixer
+
+      # Lint: Check for files with names that would conflict on a
+      # case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+      - id: check-case-conflict
+
+      # Lint: Checks that non-binary executables have a proper shebang.
+      - id: check-executables-have-shebangs
+
+      # Lint: JSON files
+      - id: check-json
+
+      # Lint: YAML files
+      - id: check-yaml
+
+  # Lint: Python code
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.0
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]

gitlab_activity-0.1.0/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+## 0.1.0 (2023-11-02)
+
+([Full Changelog](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/compare/6c710c92265819a8a2d1a59317b9c7e9d0d47fe7...fcc20006f29d94bbe20cbb139a07ff117c9fa566?from_project_id=51534402&straight=false))
+
+### New features added
+
+- Add release workflows in CI and get first and last commits when no tags found [!12](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/12) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add source code [!1](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/1) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### Enhancements made
+
+- Add example configs [!8](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/8) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Change vars & opts names for consistency [!7](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/7) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Improve getting latest tags of local repos [!5](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/5) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Look for auth token from CI vars [!4](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/4) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Get created and also merged/closed activity [!3](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/3) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Improve API and grouping logic [!2](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/2) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### Build changes
+
+- Drop support for Python 3.12 [!16](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/16) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### CI changes
+
+- Fixes in CI and docs [!13](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/13) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add release workflows in CI and get first and last commits when no tags found [!12](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/12) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add CI YAML file for testing [!10](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/10) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### Maintenance and upkeep improvements
+
+- Change vars & opts names for consistency [!7](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/7) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Improve getting latest tags of local repos [!5](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/5) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Improve API and grouping logic [!2](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/2) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### Documentation improvements
+
+- Add sphinx API docs [!14](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/14) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Fixes in CI and docs [!13](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/13) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add docs [!11](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/11) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add example configs [!8](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/8) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### Unlabelled Merged MRs
+
+- Add new cli tests [!15](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/15) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add more tests [!9](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/9) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+- Add tests [!6](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/merge_requests/6) ([@mahendrapaipuri](https://gitlab.com/mahendrapaipuri))
+
+### [Contributors to this release](https://mahendrapaipuri.gitlab.io/gitlab-activity/usage#contributors-list)
+
+[@mahendrapaipuri](https://gitlab.com/mahendrapaipuri)
+
+<!-- <END NEW CHANGELOG ENTRY> -->

gitlab_activity-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,159 @@
+# Contributing to GitLab Activity
+
+If you're reading this section, you're probably interested in contributing to
+`gitlab-activity`. Welcome and thanks for your interest in contributing. There are many
+ways to contribute to the project.
+
+## Contribution types
+
+### Bug reports
+
+Bug reports are an important type of contribution - it's important to get feedback
+about how the tool is failing, and there's no better way to do that than to hear
+about real-life failure cases. A good bug report will include:
+
+- A minimal, reproducible example - a small, self-contained script that can reproduce
+  the behavior is the best way to get your bug fixed. For more information and tips on
+  how to structure these, read
+  [Stack Overflow's guide to creating a minimal, complete, verified example](https://stackoverflow.com/help/mcve).
+
+- The platform and versions of everything involved, at a minimum please include
+  operating system, python version and `gitlab-activity` version.
+  Instructions on getting your versions:
+
+      - `gitlab-activity`: `python -c "import gitlab-activity; print(gitlab-activity.__version__)"`
+      - Python: `python --version`
+
+- A description of the problem - what is happening and what should happen.
+
+While pull requests fixing bugs are accepted, they are not required - the bug report
+in itself is a great contribution.
+
+### Feature requests
+
+If you would like to see a new feature in `gitlab-activity`, it is probably best to
+start an issue for discussion rather than taking the time to implement a feature
+which may or may not be appropriate for `gitlab-activity`. For minor features
+(ones where you don't have to put a lot of effort into the MR), a pull request
+is fine but still not necessary.
+
+### Merge requests
+
+If you would like to fix something in `gitlab-activity` - improvements to documentation,
+bug fixes, feature implementations, fixes to the build system, etc - merge requests
+are welcome! Where possible, try to keep your coding to PEP 8 style. `pre-commit` can
+be used to stay within styling guides.
+
+The most important thing to include in your merge request are tests - please write
+one or more tests to cover the behavior you intend your patch to improve.
+
+## Development Setup
+
+### Using a virtual environment
+
+It is advisable to work in a virtual environment for development of `gitlab-activity`.
+This can be done using [virtualenv](https://virtualenv.pypa.io/):
+
+```
+python -m virtualenv .venv      # Create virtual environment in .venv directory
+source .venv/bin/activate       # Activate the virtual environment
+```
+
+Alternatively you can create a
+[conda environment](https://conda.io/docs/user-guide/tasks/manage-environments.html):
+
+```
+conda create -n gitlab-activity                # Create a conda environment
+# conda create -n gitlab-activity python=3.8   # Or specify a version
+conda activate gitlab-activity                 # Activate the conda environment
+```
+
+Once your virtual environment is created, install the library in development mode:
+
+```
+pip install -e '.[dev]'
+```
+
+This will install all the package dependencies including the ones required for
+development.
+
+### pre-commit
+
+The package uses [pre-commit](https://pre-commit.com/) to run styling packages like
+`black`, `ruff`, _etc._. First install `pre-commit` components to setup the development
+environment
+
+```
+pre-commit install
+```
+
+After this step, `pre-commit` will run at every git commit and reformats the files
+according to styling config provided in the `pyproject.toml`. If user wishes to run
+`pre-commit` manually, it can be done using
+
+```
+pre-commit run --all-files
+```
+
+### Tests
+
+Tests can be run in the current environment using `pytest` command
+
+```
+pytest
+```
+
+In order to test multiple Python versions, we can use
+[hatch environments](https://hatch.pypa.io/latest/environment/) which are analogous
+to tools `tox` and `nox`. Unlike the stated tools, `hatch` can create a Python
+installation without having to dependent on existing Python versions on the
+local machine.
+
+In order to use `hatch` environments, first the user need to install `hatch` in
+the current environment
+
+```
+pip install 'hatch>1.7.0'
+```
+
+:::note
+
+It is important to install `hatch>1.7.0` as the feature that creates the different
+versions of Python environments has been added after `1.7.0`. See related
+[PR](https://github.com/pypa/hatch/pull/1002).
+
+:::
+
+Once `hatch` is installed, users can run test in a given Python environment using
+
+```
+hatch run +py=3.11 test:test
+```
+
+This command will do following:
+
+- Create a Python environment with Python 3.11
+- Install project and its dependencies in development mode
+- Invoke `pytest` command and executes all the tests
+
+If user wishes to test all Python versions that the package supports, they can do
+it with single command
+
+```
+hatch run test:test
+```
+
+If users want to run the tests with all the supported Python versions _modulo_
+Python 3.8, it can be done using
+
+```
+hatch run -py=3.8 test:test
+```
+
+To list all the supported environments of current package, we can use
+
+```
+hatch env show --ascii
+```
+
+which will list the names of supported environments and their variants.

gitlab_activity-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Mahendra Paipuri
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.