scholarimpact 0.0.1.dev1__tar.gz

scholarimpact-0.0.1.dev1/.github/workflows/cleanup-prereleases.yml

@@ -0,0 +1,77 @@
+name: Cleanup Pre-releases
+
+on:
+  schedule:
+    # Run daily at 2 AM UTC
+    - cron: '0 2 * * *'
+  workflow_dispatch:
+    inputs:
+      days_to_keep:
+        description: 'Number of days to keep pre-releases'
+        required: false
+        default: '7'
+        type: string
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Clean up old pre-releases
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const daysToKeep = parseInt('${{ github.event.inputs.days_to_keep || '7' }}');
+          const cutoffDate = new Date();
+          cutoffDate.setDate(cutoffDate.getDate() - daysToKeep);
+          
+          console.log(`Cleaning up pre-releases older than ${daysToKeep} days (before ${cutoffDate.toISOString()})`);
+          
+          // Get all releases
+          const releases = await github.rest.repos.listReleases({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            per_page: 100
+          });
+          
+          let deletedCount = 0;
+          
+          for (const release of releases.data) {
+            // Only process pre-releases with PR tags
+            if (release.prerelease && release.tag_name.includes('-pr')) {
+              const releaseDate = new Date(release.created_at);
+              
+              if (releaseDate < cutoffDate) {
+                console.log(`Deleting pre-release: ${release.tag_name} (created: ${releaseDate.toISOString()})`);
+                
+                try {
+                  // Delete the release
+                  await github.rest.repos.deleteRelease({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    release_id: release.id
+                  });
+                  
+                  // Delete the tag
+                  await github.rest.git.deleteRef({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    ref: `tags/${release.tag_name}`
+                  });
+                  
+                  deletedCount++;
+                  console.log(`✓ Deleted: ${release.tag_name}`);
+                } catch (error) {
+                  console.error(`✗ Failed to delete ${release.tag_name}:`, error.message);
+                }
+              } else {
+                console.log(`Keeping: ${release.tag_name} (created: ${releaseDate.toISOString()})`);
+              }
+            }
+          }
+          
+          console.log(`Cleanup complete. Deleted ${deletedCount} pre-releases.`);

scholarimpact-0.0.1.dev1/.github/workflows/release.yml

@@ -0,0 +1,218 @@
+name: Build and Release
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: [ main ]
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+    branches: [ main ]
+
+jobs:
+  generate-version:
+    runs-on: ubuntu-latest
+    # Skip if Tests workflow failed
+    if: ${{ github.event_name == 'pull_request' || github.event.workflow_run.conclusion == 'success' }}
+    outputs:
+      version: ${{ steps.generate_version.outputs.version }}
+      version_tag: ${{ steps.generate_version.outputs.version_tag }}
+      github_tag: ${{ steps.generate_version.outputs.github_tag }}
+      is_prerelease: ${{ steps.generate_version.outputs.is_prerelease }}
+      pr_number: ${{ github.event.number }}
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Generate version for PR
+      if: github.event_name == 'pull_request'
+      id: generate_pr_version
+      run: |
+        # Get base version from latest tag or default to 0.0.0
+        BASE_VERSION=$(git describe --tags --abbrev=0 2>/dev/null | sed 's/^v//' || true)
+        if [ -z "$BASE_VERSION" ]; then
+          BASE_VERSION="0.0.0"
+        fi
+        
+        # Generate PEP 440 compatible pre-release version
+        SHORT_SHA=$(git rev-parse --short HEAD)
+        PR_NUMBER=${{ github.event.number }}
+        
+        # Use PEP 440 compatible format
+        PRERELEASE_VERSION="${BASE_VERSION}.dev${PR_NUMBER}+${SHORT_SHA}"
+        PRERELEASE_TAG="v${PRERELEASE_VERSION}"
+        
+        # GitHub tag for releases (without +sha)
+        GITHUB_TAG="v${BASE_VERSION}-pr${PR_NUMBER}.${SHORT_SHA}"
+        
+        echo "version=$PRERELEASE_VERSION" >> $GITHUB_OUTPUT
+        echo "version_tag=$PRERELEASE_TAG" >> $GITHUB_OUTPUT
+        echo "github_tag=$GITHUB_TAG" >> $GITHUB_OUTPUT
+        echo "is_prerelease=true" >> $GITHUB_OUTPUT
+    
+    - name: Generate version for release
+      if: github.event_name == 'workflow_run'
+      id: generate_release_version
+      uses: paulhatch/semantic-version@v5.4.0
+      with:
+        tag_prefix: "v"
+        major_pattern: "(MAJOR)"
+        minor_pattern: "(MINOR)"
+        version_format: "${major}.${minor}.${patch}"
+        bump_each_commit: true
+    
+    - name: Set outputs
+      id: generate_version
+      run: |
+        if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+          echo "version=${{ steps.generate_pr_version.outputs.version }}" >> $GITHUB_OUTPUT
+          echo "version_tag=${{ steps.generate_pr_version.outputs.version_tag }}" >> $GITHUB_OUTPUT
+          echo "github_tag=${{ steps.generate_pr_version.outputs.github_tag }}" >> $GITHUB_OUTPUT
+          echo "is_prerelease=true" >> $GITHUB_OUTPUT
+        else
+          echo "version=${{ steps.generate_release_version.outputs.version }}" >> $GITHUB_OUTPUT
+          echo "version_tag=${{ steps.generate_release_version.outputs.version_tag }}" >> $GITHUB_OUTPUT
+          echo "github_tag=${{ steps.generate_release_version.outputs.version_tag }}" >> $GITHUB_OUTPUT
+          echo "is_prerelease=false" >> $GITHUB_OUTPUT
+        fi
+
+  build-python:
+    needs: generate-version
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+      attestations: write
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install -e .
+    
+    - name: Set version for setuptools-scm
+      run: |
+        git config user.name "GitHub Actions"
+        git config user.email "actions@github.com"
+        echo "About to create tag: ${{ needs.generate-version.outputs.version_tag }}"
+        git tag -a "${{ needs.generate-version.outputs.version_tag }}" -m "Release ${{ needs.generate-version.outputs.version_tag }}"
+        echo "Created tag: ${{ needs.generate-version.outputs.version_tag }}"
+    
+    - name: Build package
+      run: make build
+    
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-artifacts
+        path: dist/*
+        retention-days: 30
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        attestations: true
+        skip-existing: true
+
+  create-release:
+    needs: [generate-version, build-python]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    
+    steps:
+    - name: Download Python artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: python-artifacts
+        path: dist/
+       
+    - name: List all artifacts
+      run: |
+        echo "Contents of dist directory:"
+        find dist -type f -ls
+    
+    - name: Create Release
+      uses: softprops/action-gh-release@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        files: dist/**/*
+        tag_name: ${{ needs.generate-version.outputs.github_tag }}
+        name: ${{ needs.generate-version.outputs.is_prerelease == 'true' && 'Pre-release' || 'Release' }} ${{ needs.generate-version.outputs.github_tag }}
+        body: |
+          ${{ needs.generate-version.outputs.is_prerelease == 'true' && format('🚧 **Pre-release build for PR #{0}**', needs.generate-version.outputs.pr_number) || '🎉 **New Release**' }}
+          
+          ${{ needs.generate-version.outputs.is_prerelease == 'true' && 'This is an automated pre-release build. Use for testing purposes only.' || github.event.head_commit.message }}
+          
+          ## Available Downloads
+          
+          ### Python Package
+          - Wheel: `scholarimpact-${{ needs.generate-version.outputs.version }}-py3-none-any.whl`
+          - Source: `scholarimpact-${{ needs.generate-version.outputs.version }}.tar.gz`
+          
+          ## Installation
+          
+          **PIP:**
+          ```bash
+          pip install https://github.com/${{ github.repository }}/releases/download/${{ needs.generate-version.outputs.github_tag }}/scholarimpact-${{ needs.generate-version.outputs.version }}-py3-none-any.whl
+          ```
+          
+          **PyPI:**
+          ```bash
+          pip install scholarimpact${{ needs.generate-version.outputs.is_prerelease == 'true' && '==' || '' }}${{ needs.generate-version.outputs.is_prerelease == 'true' && needs.generate-version.outputs.version || '' }}
+          ```
+
+        prerelease: ${{ needs.generate-version.outputs.is_prerelease == 'true' }}
+        draft: false
+    
+    - name: Comment on PR
+      if: needs.generate-version.outputs.is_prerelease == 'true'
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const prNumber = ${{ needs.generate-version.outputs.pr_number }};
+          const tag = '${{ needs.generate-version.outputs.github_tag }}';
+          const version = '${{ needs.generate-version.outputs.version }}';
+          
+          const comment = `## 🚧 Pre-release Ready
+          
+          A pre-release has been created for this PR: **${tag}**
+          
+          ### Quick Install
+          
+          **From PyPI (recommended):**
+          \`\`\`bash
+          pip install scholarimpact==${version}
+          \`\`\`
+          
+          **From GitHub Release:**
+          \`\`\`bash
+          pip install https://github.com/${{ github.repository }}/releases/download/${tag}/scholarimpact-${version}-py3-none-any.whl
+          \`\`\`
+          
+          ### Available Artifacts
+          - **Python**: wheel and source distribution
+          
+          View all artifacts at: https://github.com/${{ github.repository }}/releases/tag/${tag}
+          `;
+          
+          github.rest.issues.createComment({
+            issue_number: prNumber,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: comment
+          });

scholarimpact-0.0.1.dev1/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main]
+  pull_request:
+    branches: [ main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install -e .
+    
+    - name: Format code
+      run: make format
+    
+    - name: Run tests
+      run: make test

scholarimpact-0.0.1.dev1/.gitignore

@@ -0,0 +1,213 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Custom additions
+example-dashboard
+my-research-dashboard
+.DS_Store
+.claude
+data
+
+# setuptools-scm generated version file
+src/scholarimpact/_version.py

scholarimpact-0.0.1.dev1/CITATION.cff

@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Tiwari"
+  given-names: "Abhishek"
+  orcid: "https://orcid.org/0000-0003-2222-2395"
+title: "ScholarImpact: A bibliometric tool to analyse, visualise, and share your research impact, output and scholarly influence using Google Scholar and OpenAlex data."
+version: 0.0.1
+date-released: 2025-08-13
+url: "https://github.com/abhishektiwari/scholarimpact"

scholarimpact-0.0.1.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Abhishek Tiwari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scholarimpact-0.0.1.dev1/Makefile

@@ -0,0 +1,68 @@
+# ScholarImpact Makefile
+
+.PHONY: help format lint test install clean build publish
+
+help:
+	@echo "Available commands:"
+	@echo "  make format    - Format Python code with black and isort"
+	@echo "  make lint      - Run linting checks with flake8 and mypy"
+	@echo "  make test      - Run tests with pytest"
+	@echo "  make install   - Install package in development mode"
+	@echo "  make clean     - Remove build artifacts and cache files"
+	@echo "  make build     - Build distribution packages"
+	@echo "  make publish   - Upload package to PyPI"
+
+format:
+	@echo "Formatting Python code..."
+	@black src/ tests/ --line-length 100
+	@isort src/ tests/ --profile black --line-length 100
+	@echo "Code formatting complete!"
+
+lint:
+	@echo "Running linting checks..."
+	@flake8 src/ tests/ --max-line-length 100 --extend-ignore E203,W503
+	@mypy src/ --ignore-missing-imports
+	@echo "Linting complete!"
+
+test:
+	@echo "Running tests..."
+	@pytest tests/ -v --cov=src/scholarimpact --cov-report=term-missing
+	@echo "Tests complete!"
+
+install:
+	@echo "Installing package in development mode..."
+	@pip install -e .
+	@echo "Installation complete!"
+
+clean:
+	@echo "Cleaning build artifacts..."
+	@rm -rf build/
+	@rm -rf dist/
+	@rm -rf *.egg-info
+	@rm -rf src/*.egg-info
+	@find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	@find . -type f -name "*.pyc" -delete
+	@find . -type f -name "*.pyo" -delete
+	@find . -type f -name ".coverage" -delete
+	@find . -type d -name ".pytest_cache" -exec rm -rf {} + 2>/dev/null || true
+	@find . -type d -name ".mypy_cache" -exec rm -rf {} + 2>/dev/null || true
+	@echo "Clean complete!"
+
+build: clean
+	@echo "Building distribution packages..."
+	@python -m build
+	@echo "Build complete! Check dist/ directory"
+
+publish: build
+	@echo "Uploading to PyPI..."
+	@python -m twine upload dist/*
+	@echo "Package published to PyPI!"
+
+# Development helpers
+dev-install:
+	@echo "Installing development dependencies..."
+	@pip install -e ".[dev]"
+	@echo "Development dependencies installed!"
+
+check: format lint test
+	@echo "All checks passed!"