Giter Club home page Giter Club logo

pep-connections's Introduction

Dane Hillard

GitHub follow Twitter follow Mastodon follow

I'm a software engineer and web developer interested in education, biotechnology, and open source.

Publishing Python Packages: Test, share, and automate your projects

The life of a maintainer can be hard. Beyond writing working code, you have to triage issues, review pull requests, and create releases regularly. Don't let the logistics of package management get in your way. Publishing Python Packages: Test, share, and automate your projects is a book about creating and streamlining a repeatable process for authoring and maintaining Python packages. Whether you're looking to create your first published Python package or trying to reduce the maintenance burden of the packages you already work on, Publishing Python Packages: Test, share, and automate your projects has something for you. Check out daneah/publishing-python-packages for the accompanying code samples.

Publishing Python Packages, a Manning book by Dane Hillard

Practices of the Python Pro

If you're new to the software development industry, consider checking out my book, Practices of the Python Pro. It provides broad introductory coverage of software design, maintenance, and testing. You might also want to check out daneah/practices-of-the-python-pro for the accompanying code samples.

Practices of the Python Pro, a Manning book by Dane Hillard

Exploring Software Extensibility

With two chapters from Practices of the Python Pro and one chapter each from Object Design Style Guide and The Design of Web APIs, Exploring Software Extensibility is a great entrypoint into the ideas that make software live a long life. Software is rarely complete, so building it to last by being open to future requirements and change is a must.

Exploring Software Extensibility, a Manning resource with chapter selections by Dane Hillard

pep-connections's People

Contributors

daneah avatar

Watchers

 avatar  avatar

pep-connections's Issues

Use reStructuredText parsing to properly parse file contents

reStructuredText is a formal grammar and it would be nice to use that rather than parsing files as plain text. This might improve the capabilities for #3 and would probably simplify and make more extensible the metadata field parsing.

Outcome

  • connect.py code uses a package for parsing reStructuredText and generates output from the structured parsed data

Include tags for PEP types

Some PEPs are meant to propose standards, but others are simply informational. Tagging each PEP in the output with its type will help differentiate them.

Outcome

  • Each output PEP has one type--<type-of-pep> tag indicating the PEP's type

Link authors and BDFL delegates

Connecting each PEP to its author(s) and BDFL delegate can help understand who has been responsible for many PEPs and specific PEP topics/areas.

Outcome

  • Each person who is either an author or a BDFL delegate has their own file containing their name as a level one heading
  • Each output PEP file has a section with a list of the authors and BDFL delegate, where each mentioned person is linked to the respective person file

Add PEP content to output files

Each output file currently has just the tags, title, and connection to other mentioned PEPs. This is easy enough to do, but doesn't let people understand what each PEP is in context as they browse it in Obsidian.

Outcome

  • Each PEP has the full PEP body in the output Markdown, transformed appropriately as noted below.

Notes

The reStructuredText can't just be shoved into the Markdown file, because the syntax will conflict. Some things should probably be transformed as well because they don't have an easy parallel. An example is the :pep: reference syntax—that could be converted to links (and possibly remove some of the need for the current Mentions section in the process)

Some of the metadata in the front matter might be able to be kept. Obsidian supports front matter in Markdown and treats it separately and specially from the document. Some is redundant with existing tags.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.