We hack together a couple of modules, do quick manual testing. Eventually, the code remains a\nhackish mess rotting away which may be fine but a little unsatisfactory.
\n--- excerpt ---
\nWe have all been there: we need to start a new project. It can be an actual project or,\nat some point in our lives, it could have been a small homework assignment. Now sitting\nin front of an empty directory, we figure we will not bother with the boilerplate yet.
\nWe hack together a couple of modules, do quick manual testing because, heck, setting up\nan actual testing infrastructure is boring and takes time. And eventually, we either\nresolve to spend the time to do it, or for a short-term project, the code remains a\nhackish mess rotting away which may be fine but a little unsatisfactory.
\nThis is why starting with a nice project template is a good idea.
\n→ Coming back? Here is a direct link to the template.
We have a couple of basic tools to support any project. Roughly, we need:
\nAnd the ability to setup all this quickly and consistently, be it for other contributors\nor ourselves two years from now.
\nLastly, if we are to share and accept contributions, on top of that we need at least:
\nThat should cover the most common needs.
\nUnless we have specific, unusual needs, it is best to stick to industry standards, as\nthey are more likely to stand the test of time.
\npytest, using pytest-cov.Continuous integration depends a bit more on the environment. If building an open-source\nproject, travis-ci has widespread use. Let's use it.
\nI will not explain how to use the tools. See the link to the template below.
\nI uploaded the template to github. It assumes a project named example. File\nlayout is straightforward:
The template uses autodoc\nto extract documentation from docstrings. This directory simply describes the structure\nof the documentation, importing extracted docstrings in the correct spots.
The namespace of the project. It should have the same name. All the code lives here,\nand all imports should therefore read like from example.foo import bar.\nAlways use full-path imports.
Unit tests. Every file in <project name> should have a matching file in tests, prefixed\nwith test_. This makes pytest recognize them automatically. In them, every test case\nshould be a function with a descriptive name starting with test_ as well.
Packaging configuration. It defines project dependencies and customizes install.\nIf the project should be runnable, this is where entry points are configured.\nIf you use the template, be sure to update author name and project url there.
Other files should be obvious by just looking at them in the template.
\nThis is it. No excuses for not having a decent setup now. The template is here,\nsetup instructions included. Feel free to copy it, use and reuse it.
\nIn no particular order:
\nIf building an asynchronous project using\nasyncio:
\npytest-asyncio and sphinxcontrib-asyncio to requirements-dev.txt.'pytest-asyncio' into the tests_require section of setup.py.'sphinxcontrib.asyncio' into the extensions section of docs/conf.py.Happy coding!
","fields":{"isPage":false,"slug":"/2018/starting-python-project"},"frontmatter":{"title":"Starting a Python Project","classname":null,"date":"2018-09-14T00:00:00.000Z","formattedDate":"September 14, 2018","isoDate":"2018-09-14T00:00:00+00:00"},"headings":[{"value":"What do we need?","depth":1},{"value":"A simple template","depth":1},{"value":"Tools","depth":2},{"value":"Layout","depth":2},{"value":"More tips and resources","depth":1}],"image":null,"series":{"name":"python","fullName":null,"fields":{"slug":"/python"}},"tags":[{"name":"code","slug":"/tag/code"}]}},"pageContext":{"series":"python","slug":"/2018/starting-python-project","previous":{"fields":{"slug":"/2018/cryptomate/the-story-so-far"},"frontmatter":{"title":"The Story So Far","series":"cryptomate"},"tags":[{"name":"architecture","slug":"/tag/architecture"}]},"next":{"fields":{"slug":"/2018/cryptomate/groundwork"},"frontmatter":{"title":"Laying the Groundwork","series":"cryptomate"},"tags":[{"name":"code","slug":"/tag/code"}]},"seriesPrevious":null,"seriesNext":{"fields":{"slug":"/2018/testing-aiohttp-client"},"frontmatter":{"title":"Unit Testing aiohttp Clients","series":"python"},"tags":[{"name":"code","slug":"/tag/code"},{"name":"testing","slug":"/tag/testing"}]}}}, "staticQueryHashes": ["1733002695","4006707078"]}