Dev

.github/release-config.yml

@@ -0,0 +1,47 @@
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+      - 'high priority'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '📝 Documentation'
+    labels:
+      - 'documentation'
+      - 'docs'
+  - title: '🧰 Maintenance'
+    labels:
+      - 'chore'
+      - 'refactor'
+  - title: '💻 Technology Updates'
+    labels:
+      - 'python'
+      - 'js'
+      - 'Javascript'
+      - 'html'
+      - 'excel'
+      - 'xbrl'
+  - title: '🎨 UI/UX'
+    labels:
+      - 'web design'
+      - 'web app'
+  - title: '📦 Other Changes'  # Default category
+    labels:
+      - '*'  # Catch-all for PRs with no matching labels
+
+template: |
+  ## Changes
+  ${{CHANGELOG}}
+
+  ## Contributors
+  ${{CONTRIBUTORS}}
+
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+sort-by: 'title'
+sort-direction: 'ascending' 

.github/workflows/changelog.yml

@@ -0,0 +1,50 @@
+name: Update Changelog
+
+on:
+  pull_request:
+    branches: [dev, main]
+    types: [opened, synchronize, closed]
+
+jobs:
+  update_changelog:
+    # Only run if PR is merged (not just closed)
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          # Need to fetch all history for changelog generation
+          fetch-depth: 0
+          # Checkout the branch that the PR is being merged into
+          ref: ${{ github.event.pull_request.base.ref }}
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Generate Changelog
+        uses: mikepenz/release-changelog-builder-action@v4
+        with:
+          configuration: ".github/release-config.yml"
+          # Specify output file
+          outputFile: "CHANGELOG.md"
+          # Use PR title and body for changelog entry
+          failOnError: false
+          toTag: ${{ github.sha }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Commit and Push Changes
+        run: |
+          # Check if there are changes to commit
+          if git diff --quiet CHANGELOG.md; then
+            echo "No changes to CHANGELOG.md"
+            exit 0
+          fi
+
+          git add CHANGELOG.md
+          git commit -m "docs: update changelog for PR #${{ github.event.pull_request.number }}"
+          git push origin ${{ github.event.pull_request.base.ref }}

.gitignore

@@ -12,9 +12,15 @@ xbrl_venv/
 .venv
 venv/
 
+# FLASK API KEY in this environment file
+.env
+
 # ignore unsaved Microsoft docs
 ~$*
 
+# Ignore cursor
+.specstory/
+
 # ignore files that change each time we run the app
 app/static/output/output.html
 app/templates/site/viewer.html

CHANGELOG.md

@@ -0,0 +1,131 @@
+## 📦 Uncategorized
+
+- Integrate Suresh's fork (with Word features)
+   - PR: #4
+- 5 word integration
+   - PR: #21
+- 20 typed dimensions
+   - PR: #27
+- module import fix
+   - PR: #29
+- 24 acfr edits
+   - PR: #35
+- 25 improve loading wheel
+   - PR: #40
+- 36 template fixes
+   - PR: #41
+- 30 support for new tables
+   - PR: #49
+- 7 sessions
+   - PR: #51
+- 28 image handling
+   - PR: #38
+- #54 implemented custom line items
+   - PR: #55
+- 52 add back button
+   - PR: #56
+- use jinja to download session specific outputs.
+   - PR: #61
+- 58 downloads session
+   - PR: #70
+- Zip download
+   - PR: #73
+- Improve uploads
+   - PR: #74
+- Fix Ogemaw bug
+   - PR: #79
+- 82 fix viewer js
+   - PR: #84
+- Custom line items adjustment to Excel template
+   - PR: #78
+- [PR] improve process updates and design
+   - PR: #87
+- #85 - Fix date parse error
+   - PR: #88
+- #68 improved web design
+   - PR: #90
+- fixed post conversion page not being displayed
+   - PR: #97
+- Adding sessions updates
+   - PR: #53
+- replaced ACFR template with Sarrah upload
+   - PR: #100
+- PIL Import so Heroku deployment works for main branch
+   - PR: #102
+- heroku still fails so updating ver and specifying arelle too
+   - PR: #103
+- fixed arelle ver
+   - PR: #104
+- changed arelle ver again
+   - PR: #105
+- parse and run added
+   - PR: #106
+- 98 address template errors
+   - PR: #107
+- Template update
+   - PR: #108
+- updated ixbrl viewer ver
+   - PR: #109
+- test push of ixbrlviewer.js change
+   - PR: #110
+- try 1.4.8 for ixbrlviewer
+   - PR: #111
+- added a runtime.txt for heroku
+   - PR: #112
+- test deletion of arelle import
+   - PR: #113
+- add back arelle release
+   - PR: #114
+- Fixed --save-viewer issue, use ixbrl-viewer from pip
+   - PR: #115
+- changed handling session using query param
+   - PR: #116
+- opens in new tab
+   - PR: #118
+- opens in new tab
+   - PR: #117
+- parentheses for negative numbers + 'No' business activities
+   - PR: #123
+- Move all partial fixes to dev branch
+   - PR: #124
+- Update .gitignore
+   - PR: #135
+- flask key .env deleted (only local on Luca pc rn)
+   - PR: #136
+- fix heading formatting issues
+   - PR: #137
+- removed context to revert clickable reconciliation tables
+   - PR: #138
+- Open tab only after conversion complete
+   - PR: #142
+- #122 uploading emailed template
+   - PR: #127
+- added condition to handle 'OPEB' to not treat it as header
+   - PR: #143
+- defined in constants.py
+   - PR: #144
+- handle different date formats in master info sheet
+   - PR: #146
+- Set up GitHub actions / CHANGELOG.md for main and dev branches
+   - PR: #148
+- Update changelog.yml
+   - PR: #149
+- Updated README.md
+   - PR: #150
+- README, License, Notices, Contributing documentation
+   - PR: #151
+- Update README.md
+   - PR: #153
+- Change location of changelog.yml
+   - PR: #154
+- Added GITHUB_TOKEN to changelog.yml
+   - PR: #155
+- Setting up release-config.yml
+   - PR: #156
+- 147 changelog automate
+   - PR: #157
+- Added message Natalie requested about warning in-prod
+   - PR: #160
+- 161 viewer not loading
+   - PR: #162
+

CONTRIBUTING.md

@@ -0,0 +1,118 @@
+# How to Contribute
+
+Thank you for your interest in contributing to our project! This document provides guidelines for contributing.
+
+## Do you want to propose a significant new feature or an important refactoring?
+
+Please contact [email protected]
+
+## Did you find a bug?
+
+* First, search through [existing issues](https://github.com/closup/process-xbrl/issues) to see if the bug has already been reported.
+* If not, create a new issue with a clear title and description.
+* Include as much relevant information as possible:
+  * Steps to reproduce the issue
+  * Expected behavior
+  * Actual behavior
+  * Any error messages
+  * Your environment (OS, Python version, etc.)
+* If possible, add a minimal code example that demonstrates the issue
+
+## Want to submit a pull request?
+
+1. First, create an issue describing the change you want to make.
+2. Fork the repository and create a new branch from `main`.
+3. Make your changes following our coding conventions.
+4. Write or update tests as needed.
+5. Update documentation as needed.
+6. Label your PR with one of the following categories:
+   - `feature`, `enhancement`, or `high priority` for new features and improvements
+   - `fix`, `bugfix`, or `bug` for bug fixes
+   - `documentation` or `docs` for documentation changes
+   - `chore` or `refactor` for maintenance tasks
+   - Technology-specific labels (`python`, `js`, `Javascript`, `html`, `excel`, `xbrl`)
+   - UI/UX labels (`web design`, `web app`)
+7. Submit a pull request with a clear title and description.
+8. Reference the issue number in your pull request description.
+
+### Pull Request Guidelines
+
+* Follow Python PEP 8 style guide
+* Include tests for new features
+* Update documentation as needed
+* Keep commits focused and atomic
+* Write clear commit messages
+* Ensure all tests pass before submitting
+* Properly label your PR for changelog categorization:
+  - 🚀 Features: use `feature`, `enhancement`, or `high priority` labels
+  - 🐛 Bug Fixes: use `fix`, `bugfix`, or `bug` labels
+  - 📝 Documentation: use `documentation` or `docs` labels
+  - 🧰 Maintenance: use `chore` or `refactor` labels
+  - 💻 Technology Updates: use `python`, `js`, `Javascript`, `html`, `excel`, or `xbrl` labels
+  - 🎨 UI/UX: use `web design` or `web app` labels
+  - 📦 Other Changes: PRs without any of the above labels will be categorized here
+
+### Code Review Process
+
+1. At least one project maintainer will review your code
+2. Changes may be requested
+3. Once approved, a maintainer will merge your PR
+
+## Minor Fixes
+
+* Any functionality change should have a GitHub issue opened. For minor changes that affect documentation, you do not need to open up a GitHub issue. Instead you can prefix the title of your PR with "MINOR: " if meets one of the following:
+  * Grammar, usage and spelling fixes that affect no more than 2 files
+  * Documentation updates affecting no more than 2 files and not more than 500 words.
+  * These should still be labeled with `documentation` or `docs` for proper changelog categorization in the 📝 Documentation section
+
+## Proposing Significant Changes
+
+For significant changes (new features, major refactoring):
+
+1. First, open an issue to discuss the proposal
+2. Include:
+   * Detailed description of the change
+   * Motivation and use cases
+   * Potential implementation approach
+3. Wait for feedback from maintainers before starting implementation
+
+## Licensing
+
+* All contributions must be compatible with our license (see License.txt)
+* By contributing, you agree that your contributions will be licensed under the same terms
+* All new files should include the University of Michigan copyright notice:
+  ```
+  Copyright © <2024> The Regents of the University of Michigan
+  ```
+
+## How Contributors Will Be Credited
+
+* All contributors will be acknowledged in our CHANGELOG.md
+
+## Questions or Need Help?
+
+* For questions about contributing, open an issue with the "question" label
+* For bug reports, use the "bug" label
+* For feature requests, use the "enhancement" label
+
+## Development Setup
+
+* Please refer to the README.md for the development setup
+
+## Code Style
+
+* Follow PEP 8 guidelines
+* Use meaningful variable and function names
+* Comment complex logic
+* Keep functions focused and modular
+* Use type hints where appropriate
+
+## Documentation
+
+* Refer to changelog.yml for the changelog when PRs are merged
+* Document new features
+* Update API documentation
+* Include docstrings for new functions/classes
+
+
+Thank you for contributing to our project! Your efforts help make this project better for everyone.

License.txt

@@ -0,0 +1 @@
+Copyright © <2024> The Regents of the University of Michigan