How to run the lint process?

[dantehemerson]

Question

I'm trying to run the lint process but I'm getting this error:

➜  py-pdf-parser git:(mater) docker-compose run --rm lint
(root) Additional property docs-autobuild is not allowed

There is something I'm missing?

Update: I'm having the same issue with the other docker-file jobs.

Before submitting an issue, please ensure you have read our CONTRIBUTING.md, and follow the Code of Conduct.

Thanks for taking the time to submit an issue. To help us understand your question and answer it quickly, please include the following information where possible:

• A good description of the question, including what you are trying to achieve and what the problems are.
• A (small as possible) example highlighting your question. Please include code that you have tried, and any files required to run it.
• Any required context.

[jstockwin]

Hey @dantehemerson,

Thanks for getting in touch. A few points:

Linting is now done by pre-commit. You can do a run locally by doing pre-commit run --all-files (you may need to pip-install pre-commit first). Apologies that the documentation is out of date there - part of resolving this issue can be to update that, although I'll not have time until the new year.

Re not being able to run the jobs from docker-compose, what docker-compose version are you running? I can see the docker-compose.yml in this repo doesn't explicitly specify a version, and the error you're getting is about one of the docker services. I suspect your version is either too new or too old to handle this. I can update docker-compose.yml, but again won't have time to get around to this for a while.

Finally, I'd note that you don't need to run these unless you're trying to develop this package. If you're just trying to use py-pdf-parser, then you can simply pip install it, and work away. See https://py-pdf-parser.readthedocs.io/en/latest/overview.html#setup for details.

Hope that helps!