deansher/slack-message-pipe

Slack app -> historical messages -> simple Python data structures -> the world

slack-message-pipe's Issues

fix undesirable pylint errors

Right now we have disabled a large number of pylint errors. We might give ourselves latitude on a few.

fix undesirable flake8 errors

Right now we have disabled a large number of flake8 errors in pre-commit. We might give ourselves latitude on a few.

in MAINTAINERS.md, document use of the __version__ in __init__.py

carefully revise README.md to reflect what we actually did

have pre-commit run tox and remove its redundant checks

Here's what gpt-4 has to say about this:

Yes, it can make sense to streamline your development and CI/CD workflows by having pre-commit run tox, especially if you're looking to reduce redundancy and maintain consistency across local and CI environments. This approach allows you to centralize your testing and linting configurations within tox.ini, making it easier to manage configurations and dependencies.

Advantages of Running Tox from Pre-commit

1. Consistency: Ensures that the same environments and commands are used both locally and in CI, reducing the "it works on my machine" problem.
2. Simplicity: Reduces the number of configuration files you need to maintain. You can define your environments, dependencies, and commands in tox.ini and have pre-commit simply trigger those environments.
3. Flexibility: Allows you to leverage tox's powerful environment management capabilities, including testing across multiple Python versions and managing complex dependencies.

How to Configure Pre-commit to Run Tox

To configure pre-commit to run tox, you'll need to add a local hook in your .pre-commit-config.yaml that runs tox. Here's an example configuration:

repos:
  - repo: local
    hooks:
      - id: tox
        name: tox
        entry: tox
        language: system
        types: [python]

This configuration defines a local hook that runs the tox command. The language: system setting tells pre-commit to use the system's environment to run the command, which requires that tox is installed in the environment where pre-commit runs.

Considerations

• Performance: Running tox from pre-commit can be slower than running individual linters or formatters directly via pre-commit, especially if tox is configured to recreate environments or run a comprehensive suite of tests and checks. Consider this trade-off based on your project's needs and the developer experience you want to achieve.
• Environment Management: Ensure that developers have tox installed in their environments or provide clear instructions on how to set up their development environment. This might include using a requirements-dev.txt file or a similar approach to manage development dependencies.
• Simplifying Tox Configuration: If you choose to run tox from pre-commit, you might want to streamline your tox.ini to focus on the environments and commands most relevant for pre-commit checks. For example, you could have a specific environment for quick checks that pre-commit runs, separate from more comprehensive test environments.

Updating CI/CD Workflows

If you adopt this approach, remember to update your CI/CD workflows accordingly. Since pre-commit will trigger tox, your CI/CD configuration might simply need to run pre-commit run --all-files to perform all checks, assuming it's set up to handle the necessary environments and dependencies.

Conclusion

Running tox from pre-commit can be a powerful way to streamline your development workflows, but it's important to consider the trade-offs in terms of performance and setup complexity. By carefully configuring your tox.ini and .pre-commit-config.yaml, you can create a consistent, manageable, and efficient workflow for your project.