🚀 Initial bookshelf release

Most of the tests Adding docs and tidying up README Adding issue templates Remove java code Reduce image size to 128 Only deploy docs on a change into the /docs/ directory Trying to get docs working Adding prefix to docs Trying to get docs working Trying to get docs working Only deploy docs on a change into the /docs/ directory Fixing some flake findings Trying pypi autodeploy Trying pypi autodeploy Trying pypi autodeploy Trying pypi autodeploy Fixing console_scripts release candidate release candidate emojis on actions rc3 ready for initial release :rocket: Initial bookshelf release :rocket: Initial bookshelf release :rocket: Initial bookshelf release :rocket: Initial bookshelf release :rocket: Initial bookshelf release
jossmoff · Oct 22, 2023 · 8ccf332 · 8ccf332
1 parent fe9abc5
commit 8ccf332
Show file tree

Hide file tree

Showing 46 changed files with 8,689 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATES/bug_report.yaml b/.github/ISSUE_TEMPLATES/bug_report.yaml
@@ -0,0 +1,78 @@
+name: 🐛 Bug report
+title: "[Bug] "
+description: Problems and issues with code of bookshelf
+labels: ["🐛 bug"]
+assignees:
+  - jossmoff
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you very much for submitting feedback to bookshelf!
+
+  - type: checkboxes
+    attributes:
+      label: Search before asking
+      description: >
+        Please make sure to search in the [issues](https://github.com/jossmoff/bookshelf/issues?q=is%3Aissue) first to see
+        whether the same issue was reported already.
+      options:
+        - label: >
+            I had searched in the [issues](https://github.com/jossmoff/bookshelf/issues?q=is%3Aissue) and found no similar
+            issues.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Version
+      description: What is the current version
+      placeholder: >
+        Please provide the version you are using.
+        If it is the trunk version, please input commit id.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What's Wrong?
+      description: Describe the bug.
+      placeholder: >
+        Describe the specific problem, the more detailed the better.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What You Expected?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How to Reproduce?
+      placeholder: >
+        Please try to give reproducing steps to facilitate quick location of the problem.
+
+        - What actions were performed
+        - Table building statement
+        - Import statement
+        - Cluster information: number of nodes, configuration, etc.
+
+        If it is hard to reproduce, please also explain the general scene.
+
+  - type: textarea
+    attributes:
+      label: Anything Else?
+
+  - type: checkboxes
+    attributes:
+      label: Are you willing to submit PR?
+      description: >
+        We very much look forward to developers or users to help solve the bookshelf problem together.
+        If you are willing to submit a PR to fix this problem, please tick it.
+      options:
+        - label: Yes I am willing to submit a PR!
+
+  - type: markdown
+    attributes:
+      value: "Thanks for completing the form!"
diff --git a/.github/ISSUE_TEMPLATES/enhancement.yaml b/.github/ISSUE_TEMPLATES/enhancement.yaml
@@ -0,0 +1,48 @@
+name: ✨ Enhancement
+description: Add an enhancement for bookshelf
+title: "[Enhancement]"
+labels: ["✨ enhancement"]
+assignees:
+  - jossmoff
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you very much for submitting feedback to bookshelf!
+  - type: checkboxes
+    attributes:
+      label: Search before asking
+      description: >
+        Please make sure to search in the [issues](https://github.com/jossmoff/bookshelf/issues?q=is%3Aissue) first to see
+        whether the same issue was reported already.
+      options:
+        - label: >
+            I have searched in the [issues](https://github.com/jossmoff/bookshelf/issues?q=is%3Aissue) and found no similar
+            issues.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: Describe the enhancement what you want, including motivation if it exists.
+
+  - type: textarea
+    attributes:
+      label: Solution
+      placeholder: >
+        Add overview of proposed solution. 
+
+        Add related materials like links if they exist.
+
+  - type: checkboxes
+    attributes:
+      label: Are you willing to submit PR?
+      description: >
+        We very much look forward to developers or users to help develop the bookshelf together.
+        If you are willing to submit a PR to implement this feature, please tick it.
+      options:
+        - label: Yes I am willing to submit a PR!
+
+  - type: markdown
+    attributes:
+      value: "Thanks for completing our form!"
diff --git a/.github/workflows/cicd.yaml b/.github/workflows/cicd.yaml
@@ -0,0 +1,29 @@
+name: 🕵️ PR Inspector Workflow
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  cicd:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: 🔄 Checkout code
+      uses: actions/checkout@v2
+
+    - name: 🐍 Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x  # Specify your desired Python version
+
+    - name: 📦 Install dependencies
+      run: pip install -r requirements-dev.txt  # Replace with your requirements file
+
+    - name: ❄️ Run Flake8
+      run: flake8 .
+
+    - name: 🧪 Run unit tests
+      run: pytest  # Replace with the command to run your tests
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -0,0 +1,31 @@
+name: 📚 Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🔄 Checkout
+        uses: actions/checkout@v3
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1
+      - name: 📥 Install modules
+        run: npm ci --prefix docs
+      - name: 🏗️ Build application
+        run: npm run build --prefix docs
+      - name: 🚀 Deploy to S3
+        run: aws s3 sync ./docs/dist/ s3://${{ secrets.BUCKET_ID }}
+      - name: ☁️ Create CloudFront invalidation
+        run: aws cloudfront create-invalidation --distribution-id ${{ secrets.DISTRIBUTION_ID }} --paths "/*"
+
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,109 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    - name: 📥 Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: 🏗️ Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: 💾 Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      🚀 Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/<package-name>  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: 📥 Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: 🚀 Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      ✒️ Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: 📥 Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: ✒️ Sign the dists with Sigstore
+      uses: sigstore/[email protected]
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: 🏷️ Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: 🚀 Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/<package-name>
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: 📥 Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: 🚀 Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
diff --git a/.gitignore b/.gitignore
@@ -157,4 +157,27 @@ cython_debug/
 #  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/
+.idea/
+
+
+# build output
+docs/dist/
+# generated types
+docs/.astro/
+
+# dependencies
+docs/node_modules/
+
+# logs
+docs/npm-debug.log*
+docs/yarn-debug.log*
+docs/yarn-error.log*
+docs/pnpm-debug.log*
+
+
+# environment variables
+docs/.env
+docs/.env.production
+
+# macOS-specific files
+docs/.DS_Store
diff --git a/README.md b/README.md
@@ -1,2 +1,35 @@
-# sdlc
-You task tracker for tracking time in the software development life cycle 
+<h1 align="center">
+  <br>
+  <img src="docs/src/assets/bookshelf.png" width="200px"/>
+  <br>
+  bookshelf
+  <br>
+</h1>
+
+<h4 align="center">
+   📚 A CLI tool for tracking your stories in the SDLC
+</h4>
+
+
+<p align="center">
+
+  <a href="https://codecov.io/gh/jossmoff/bookshelf">
+    <img src="https://codecov.io/gh/jossmoff/bookshelf/branch/main/graph/badge.svg" />
+  </a>
+
+  <a href="https://github.com/jossmoff/bookshelf/issues">
+    <img src="https://img.shields.io/github/issues/jossmoff/bookshelf.svg">
+  </a>
+
+  <a href="https://github.com/jossmoff/bookshelf/pulls">
+    <img src="https://img.shields.io/github/issues-pr/jossmoff/bookshelf.svg">
+  </a>
+
+  <a href="https://github.com/tronprotocol/jossmoff/bookshelf/graphs/contributors">
+    <img src="https://img.shields.io/github/contributors/jossmoff/bookshelf.svg">
+  </a>
+
+  <a href="LICENSE">
+    <img src="https://img.shields.io/github/license/jossmoff/bookshelf.svg">
+  </a>
+</p>
diff --git a/bin/bookshelf b/bin/bookshelf
@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+import os
+import sys
+
+sys.dont_write_bytecode = True  # prevent creation of .pyc files
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+import bookshelf.__main__
+
+if __name__ == "__main__":
+    sys.exit(bookshelf.__main__.entry_point())
diff --git a/bookshelf/__init__.py b/bookshelf/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.1.0"