samueldg / async-standups

Write, publish, and keep track of your async standup reports.

Async Standup

This tool helps you write, publish, and keep track of your async standup reports.

The standup data will be saved and manipulated in YAML files, and published to Slack in Markdown format.

Setup

You will need Python 3.8+ and Poetry installed. Then clone this repo and run:

poetry install
poetry run standup bootstrap

Usage

• standup --help: Display general usage help.
• standup bootstrap: Create the basic project configuration.
• standup copy: Copy yesterday/today's standup file for the next day.
• standup publish: Publish your update on the right Slack channel.

Slack App Configuration

In order to publish your updates to Slack, you will need to:

1. Create a Slack app.
2. Add the chat:write scope to the app's User Token Scopes.
3. Install the app to your workspace.
4. Authorize your user with the app.
5. Add the app to the channel where you want to post.

Once these steps are complete, go through standup bootstrap and you'll be prompted for the token and channel ID.

async-standups's Issues

Add bootstrap command

Currently the YAML format and data hierarchy are not documented, so you can't really get setup.

It would be nice to have a command that does it for you: sets data/YEAR/MONTH dir, asks for slack channel, etc.

Request User Token instead of `chat:write.customize` permission

Create year/month directory if it doesn't exist

Document data and output formats in the README

Show an example of the YAML data, and what gets posted to Slack.

Python package with setup.py & entrypoint script

I want to do standup instead of python standup.py, and potentially even install with pipsi, so I don't have to always activate the virtualenv.

Improve Python package setup

• Use setup.cfg?
• Get version from __init__.py::__version__
• Find less ugly way to add console_scripts
• Add Trove calssifiers
• Review setup() parameters to see if anything is missing (license and what not)

Ensure next-day copy doesn't include weekend days

Update Slack to use new APIs

Currently, this repo uses:

• A legacy token for authentication, which don't work anymore.
• A deprecated as_user param to chat_postMessage
  • See https://api.slack.com/authentication/migration#as_user

In order to be able to actually post to Slack again, it should instead use the latest auth tokens and message authorship API.

Missing template file from package resource

When running:

standup publish --dry-run

I have the following output:

Traceback (most recent call last):
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/bin/standup", line 11, in <module>
    load_entry_point('standup', 'console_scripts', 'standup')()
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/Users/samuel/workspace/delphia/standups/standup/main.py", line 146, in publish
    rendered_text = get_formatted_standup(standup_data)
  File "/Users/samuel/workspace/delphia/standups/standup/main.py", line 50, in get_formatted_standup
    template = template_env.get_template(TEMPLATE_FILE)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/jinja2/environment.py", line 830, in get_template
    return self._load_template(name, self.make_globals(globals))
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/jinja2/environment.py", line 804, in _load_template
    template = self.loader.load(self, name, globals)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/jinja2/loaders.py", line 113, in load
    source, filename, uptodate = self.get_source(environment, name)
  File "/Users/samuel/.local/share/virtualenvs/standups-fUqYa_L5/lib/python3.7/site-packages/jinja2/loaders.py", line 187, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: template.md.j2

because the package is not able to find the file.

The problem is either:

1. The file is not correctly included in the package
2. The code isn't looking for the template in the right location.