118 create changelog

.github/workflows/ci-team-34.yaml

@@ -0,0 +1,58 @@
+name: Team 34 CI Pipeline
+
+on: [push, pull_request]
+
+env:
+  POETRY_VERSION: "1.8.3"
+  DEFAULT_PY_VERSION: "3.11"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ env.DEFAULT_PY_VERSION }}
+
+    - name: Linting
+      env:
+        RUFF_OUTPUT_FORMAT: github
+      run: |
+        pip install ruff
+        ruff check bot
+
+  test-with-coverage:
+    needs: lint
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Poetry
+      shell: bash
+      run: pipx install poetry==${{ env.POETRY_VERSION }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ env.DEFAULT_PY_VERSION }}
+
+    - name: Install dependencies
+      run: poetry install
+
+    - name: Run tests with coverage
+      run: |
+        poetry run coverage run -m pytest tests
+        poetry run coverage report
+
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v2
+      with:
+        name: coverage-report
+        path: coverage.xml

.vscode/settings.json

@@ -42,4 +42,4 @@
     },
     "terminal.integrated.scrollback": 100000,
     "workbench.sideBar.location": "right"
-}
+}

CHANGELOG.md

@@ -0,0 +1,313 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- *(flake)* Add flake
+- *(flake)* Add direnv config
+- *(gitignore)* Ignore direnv and mypy directories
+- *(flake)* Package the bot
+- *(docker)* Add dockerfile
+- *(docker)* Add compose file
+- *(bot)* Add cli
+- *(bot)* Add the 'get_subscribers' command
+- *(bot)* Schedule since the specified date
+- *(flake)* Use treefmt-nix
+- *(flake)* Scripts
+- *(bot, readme)* Provide an example for '/set_meeting_time'
+- *(license)* Add mit license
+- *(bot)* Add ru messages
+- *(requirements)* Init
+- *(requirements)* Add meeting questions
+- *(readme)* Add i18n section
+- *(scripts)* Add a script to generate locales files
+- *(locales)* Add ru and en
+- *(dockerfile)* Copy locales
+- *(readme)* Motivation
+- *(requirements)* Add glossary
+- *(requirements)* Define command types
+- *(requirements)* Add dialog scenarios
+- *(scripts)* Add script to start a bot
+- *(requirements)* Add references
+- *(requirements)* Add top-level section name
+- *(poetry)* Add Babel as a dev dependency
+- *(configuration)* Draft a roles and responsibilities doc
+- *(policies-processes-procedures)* Init
+- *(policies-processes-procedures)* Add processes diagram
+- *(nodejs)* Add package.json and package-lock.json
+- *(gitignore)* Ignore nodejs directory
+- *(sprint-docs)* Init in Russian
+- *(git-workflow-process)* Init
+- *(vscode)* Add recommended extensions
+- *(vscode)* Add settings
+- *(vscode)* Add Live Share to recommended extensions
+- *(snippets)* Init snippet for receiving reminders
+- *(scenarios)* Init a scenario
+- *(snippets)* Add handle reminder period change state
+- *(glossary)* Init
+- *(scenarios)* Add a link to glossary
+- *(scenarios)* Add a link to glossary
+- *(scenarios)* Init a scenario template
+- *(git-workflow-process)* Init
+- *(vscode)* Add recommended extensions
+- *(vscode)* Add settings
+- *(vscode)* Add Live Share to recommended extensions
+- *(snippets)* Init snippet for receiving reminders
+- *(scenarios)* Init a scenario
+- *(snippets)* Add handle reminder period change state
+- *(glossary)* Init
+- *(scenarios)* Add a link to glossary
+- *(scenarios)* Add a link to glossary
+- *(sprint)* Add a link to policy, process, procedure explanation
+- *(sprint)* Add an Issues policy
+- *(topics)* Store separate chat states for supergroup topics
+- *(topics)* Implement per-topic meeting messages
+- *(topics)* Send reminders w.r.t topics
+- *(scenarios)* Add set_personal_meetings_time scenario
+- *(scenarios)* Add the definition of a "period"
+- *(docs)* Add glossary
+- *(vscode)* Add markdown sort to sort the glossary
+- *(issues)* Specify when a task is completed
+- *(issues)* Add a scenario issue form
+- *(issues)* Disable blank issues
+- *(issues)* Add script to generate issue forms
+- *(issues)* Add templates
+- *(flake)* Add jinja2-cli to devshell tools
+- *(glossary)* Define Actor
+- *(glossary)* Add cross-references
+- *(docker)* Enable environment variables for authentication
+- *(bot)* Use mongo service name, username and password from env variables
+- *(topics)* Store separate chat states for supergroup topics
+- *(topics)* Send reminders w.r.t topics
+- Change default callback separator symbol from ':' to '|' to be able to work with intervals
+- Edit empty schedule to be dictionary instead of list
+- Edit mongodb config to return datetime in offset-aware state
+- Edit filters to work with callbacks
+- Add group of states for interval editing
+- Edit interval model to store times in UTC
+- Modify keyboards for new callbacks and intervals
+- Add fields to chat user document to handle interval editing
+- Edit error messages to more use friendly form
+- Connect al operations with mongodb and rework interval editng
+- *(CI)* Add file for CI settings in Github Actions
+- *(CI)* Update ci-team-34.yaml
+- *(CI)* Update ci-team-34.yaml
+- *(linter)* Added ruff(linter)
+- *(keyboards)* Add file for keyboards
+- *(schedule)* Add file for handling user working time setting
+- *(commands)* Add /set_personal_working_time to commands and modify handlers file for work time settings
+- *(intervals)* Add files to store callback dataclasses and pydantic models for time intervals
+- *(callbacks)* Add callbacks for intervals editing and weekday toggling
+- *(intervals)* Add base models for time intervals and weekdays
+- *(keyboards)* Add callbacks and inline queries to buttons
+- *(schedule)* Add all necessary handlers for menu with schedule
+- *(intervals)* Add interval validation and exceptions
+- *(messages)* Add messages if user entered invalid interval
+- *(keyboards)* Add keyboard markup for wrong interval input
+- *(schedule)* Add handlers for wrong input and reentering intervals
+- *(schedule)* Add default intervals handling
+- *(db)* Add fields in db
+- *(middlewares)* Add middlewares file and connected them with dispatcher
+- *(topics)* Store separate chat states for supergroup topics
+- *(topics)* Implement per-topic meeting messages
+- *(topics)* Send reminders w.r.t topics
+- *(intervals)* Edit Interval class to use datetime instead of datetime.time
+- *(intervals)* Modified merge intervals function to merge only unique intervals
+- *(fsm)* Add file for storing custom FSM states
+- *(callbacks)* Change default callback separator symbol from ':' to '|' to be able to work with intervals
+- *(constants)* Edit empty schedule to be dictionary instead of list
+- *(db)* Edit mongodb config to return datetime in offset-aware state
+- *(filters)* Edit filters to work with callbacks
+- *(fsm)* Add group of states for interval editing
+- *(intervals)* Edit interval model to store times in UTC
+- *(keyboards)* Modify keyboards for new callbacks and intervals
+- *(db)* Add fields to chat user document to handle interval editing
+- *(messages)* Edit error messages to more use friendly form
+- *(schedule)* Connect all operations with mongodb and rework interval editng
+- *(schedule)* Add timezone changing support
+- *(commands)* Edit command name for schedule editing
+- *(keyboards)* Add missing keyboards from scenario
+- *(messages)* Add missing messages from scenario
+- *(schedule)* Add logic to work with default and personal schedule + keyboards for interval editing + Cancel/Save layout
+- *(intervals)* Add function to ckeck if time is in schedule or not
+- *(meetings)* Add check if user is working by his working hours
+- *(schedule)* Remove legacy command for setting working days
+- *(menu)* Add all commands' names and descriptions to Telegram command menu
+- *(intervals)* Add uuid for each interval and add function for shift recalculating
+
+### 🐛 Bug Fixes
+
+- *(bot)* Make it work
+- *(bot)* Remove unused imports
+- *(bot, readme)* Bot description
+- *(bot)* Help message
+- *(bot)* Improve wording in the description
+- *(description)* Use 'Daily Scrum' instead of 'scrum stand-up' in descriptions
+- *(bot)* Move files
+- *(poetry)* Remove unused dependencies
+- *(bot)* Rename a module because python doesn't like types.py
+- *(flake)* Add more 'follows'
+- *(poetry)* Remove old package from dependencies
+- *(bot, readme)* Use a data directory
+- *(bot)* Strip spaces
+- *(bot, docker)* Use mongo, add basic time handling
+- *(bot)* Switch to ISO 8601 time, rename 'state' -> 'chat_state'
+- *(bot)* Improve messages for the 'unsubscribe' command
+- *(bot)* Schedule meetings no earlier than on the set date and time
+- *(flake)* Remove poetry2nix
+- *(bot)* Wording
+- *(bot)* Don't run a job after the job has expired long ago
+- *(poetry)* Add babel
+- *(scripts)* Run command via poetry
+- *(readme)* Bot description
+- *(requirements)* Update non-functional requirements
+- *(requirements)* Section name
+- *(requirements)* I18n
+- *(requirements)* Commands
+- *(readme)* Add motivation point
+- *(requirements)* Wording
+- *(bot)* Move files
+- *(docker)* Update bot directory
+- *(locales)* Update bot directory
+- *(poetry)* Update bot directory
+- *(flake)* Update script
+- *(requirements)* Update command names
+- *(readme)* Bot link
+- *(bot)* Sample time
+- *(bot)* Handle missing users
+- *(readme)* Update project name, description, messages
+- *(readme)* Instructions for running
+- *(bot)* Wording
+- *(readme)* Wording
+- *(bot)* Add blank lines in messages
+- *(bot)* Wording
+- *(configuration)* Wording
+- *(configuration)* Anchors
+- *(configuration)* Links
+- *(roles-and-responsibilities)* Sort members in the lexicographic order
+- *(roles-and-responsibilities)* Remove todo
+- *(roles-and-responsibilities)* Use lists in Reponsible people sections
+- *(roles-and-responsibilities)* Update Task activity sections
+- *(roles-and-responsibilities)* Remove the `GitHub Issues Management` responsibility
+- *(roles-and-responsibilities)* Combine the Mini App responsibility with Backend and Frontend responsibilities
+- *(roles-and-responsibilities)* Format the file
+- *(roles-and-responsibilities)* Replace "Task characteristics" with "Task activity"
+- *(roles-and-responsibilities)* Improve wording in "Task activity" sections
+- *(scenarios)* Rename "Person" -> "User"
+- *(scenarios)* Wording
+- *(scenarios)* Wording
+- *(snippets)* Simplify wording
+- *(snippets)* Simplify wording
+- *(snippets)* Rename "Person" -> "User"
+- *(snippets)* Use more precise terminology
+- *(snippets)* Use more precise terminology
+- *(scenarios)* Improve wording
+- *(scenarios)* Improve wording
+- *(scenarios)* Move the definition of uppercase words to glossary
+- *(scenarios)* Update scenario template
+- *(scenarios)* Rename "Person" -> "User"
+- *(scenarios)* Wording
+- *(scenarios)* Wording
+- *(snippets)* Simplify wording
+- *(snippets)* Simplify wording
+- *(snippets)* Rename "Person" -> "User"
+- *(snippets)* Use more precise terminology
+- *(snippets)* Use more precise terminology
+- *(scenarios)* Improve wording
+- *(scenarios)* Improve wording
+- *(scenarios)* Term formatting
+- *(configuration)* Remove old file
+- *(reminder)* Make message babel-friendly
+- *(configs)* Revert accidental change in settings configuration file
+- *(scenarios)* Optimize set_personal_meetings_time tapping + and changing timeslot
+- *(scenarios)* Change command name
+- *(scenarios)* Describe bot buttons in the message about wrong format of an interval
+- *(scenarios)* Remove a redundant quote
+- *(scenarios)* Replace "period" with "interval"
+- *(glossary)* Explain the UPPERCASE words more prominently
+- *(glossary)* Move to the `docs` directory
+- *(scenarios)* Links to the glossary
+- *(scenarios)* Remove old glossary
+- *(glossary)* Use sections for definitions
+- *(issues)* Update the template
+- *(issues)* Rename the template
+- *(issues)* Rewrite a list
+- *(issues)* Update the template
+- *(issues)* Remove an unnecessary template
+- *(issues)* Improve wording
+- *(issues)* Improve grammar
+- *(issues)* Improve wording
+- *(issues)* Rewrite using passive voice
+- *(issues)* Sentence order
+- *(issues)* Formatting
+- *(issues)* Improve term
+- *(issues)* Default title
+- *(issues)* Remove templates
+- *(issues)* Template values
+- *(issues)* Use a space for the form title
+- *(issues)* Use variables in form titles
+- *(issues)* Add an assignee for scenario issues
+- *(issues)* Add default labels for scenario issues
+- *(issues)* Change quote pairs
+- *(issues)* Remove full stops
+- *(issues)* Don't please
+- *(sprint)* Use the main glossary
+- *(glossary)* Add missing links
+- *(issues)* Improve wording in scenario issue forms
+- *(issues)* Explain the rules for the Task issue title
+- *(issues)* Wording
+- *(issues)* Update default labels
+- *(docker)* Make the bot service depend on the mongodb service
+- *(readme)* Update .env example to mention username and password
+- *(configs)* Revert accidental change in settings configuration file
+- *(CI)* Add dependencies for testing in yaml file
+- *(CI)* Add dependencies for testing in CI
+- *(CI)* Add motor dependency for testing in CI
+- *(intervals)* Made some minor changes to make classes simplier
+- *(reminders)* Fix bug with phantom notifications (again)
+- *(configs)* Revert accidental change in settings configuration file
+- *(reminders)* Fix indents in user block message and add text to notification message
+- *(intervals)* Rework algorithm for interval merging
+
+### 🚜 Refactor
+
+- *(bot)* Use a constant for week days
+- *(bot)* Move bot message to constants
+- *(bot)* Move messages to a separate module
+- *(bot)* Change 'standup' to 'meeting' in more places
+- *(bot)* Use a class for constants directly
+- *(bot)* Move bot code to a separate module
+- *(bot)* Simplify filters
+- *(bot)* Use classes for command names and descriptions
+- *(bot)* Construct messages using constants, organize code to support basic i18n
+- *(readme)* Add Develop section
+- *(typing)* Adjust topic_id type hint
+- *(linter)* Fix linter errors
+- *(tests)* Updated .coverage
+- *(merge)* Resolved merge conflict
+- *(typing)* Adjust topic_id type hint
+- *(linter)* Delete unused imports and other errors caught by linter
+- *(schedule)* Edit command and function names, refactor field order in db
+- *(merge)* Resolved merge conflicts
+- *(tests)* Refactored code according to the linter
+
+### 🧪 Testing
+
+- *(unit)* Added unit tests for 3 functions + script that runs tests
+- *(tool)* Added coverage tool
+- *(unit)* Renamed a test
+- *(unit)* Added tests for Interaval class
+
+### ⚙️ Miscellaneous Tasks
+
+- *(locales)* Update
+- *(issues)* Generate issue forms
+
+### Init
+
+- *(all)* Start development
+
+<!-- generated by git-cliff -->