Low hanging fruits in building software: Write, Test, Document, Lint, Format, Build, Deploy, Publish, Maintain & Release your software package!

  • genre: break‑out‑group
  • title: Low hanging fruits in building software: Write, Test, Document, Lint, Format, Build, Deploy, Publish, Maintain & Release your software package!
  • presenter: @lkstrp
  • description:

Software development can be hard and most people struggle with similar problems. But there are many low hanging fruits with tools and processes that make it easy to build your own open source software. Join us for this workshop to kick start or boost your project. We will discuss how to write, build, test, document, lint, format, build, deploy, publish, maintain & release your software package to survive in the open source jungle and make it easy for users to join, contribute or just use your tool.

These are a number of different topics and resources will be provided for all of them. During the workshop there are multiple things you can do: Work on the provided demo project, bring your own code and improve your package or just share your own experience.

See Documentation Website.

While in theory these resources are applicable to any project, we are going to focus on the Python universe.

  • background: @lkstrp is a research software engineer at the Technical University of Berlin and develops and maintains frameworks and models in the PyPSA universe.

  • optional link to the code repository: Python Package Development

5 Likes

In Grenoble, someone suggested a session this year on test-driven development with the challenge “does anyone working in scientific software development actually use test-driven development?”

Thank you all for attending the session.

The [Best Practices] website (Python Package Development) will remain online, so you can always come back and check it out. And again, any further contributions or things that are unclear, just contribute directly to the repo.

I would also appreciate if you could give me some feedback on the session.