Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate Development Tools from the Development Guide #33

Open
mcdonnnj opened this issue Oct 29, 2020 · 3 comments
Open

Separate Development Tools from the Development Guide #33

mcdonnnj opened this issue Oct 29, 2020 · 3 comments

Comments

@mcdonnnj
Copy link
Member

🚀 Feature Proposal

Separate the Development Tools currently stored in project_setup/scripts into their own repository as a Python package.

Motivation

@hillaryj created an issue to add testing to the scripts in the above mentioned directory in #31 , but I believe it would be better to separate tooling from documentation.

Example

One would be able to install the development tools as a Python package a la pip install git+https://github.com/cisagov/development-tools.git and the scripts would be available in the environment.

Pitch

As it stands it is difficult to add testing and keep Python related skeleton updates current in this project because:

  1. It descends from cisagov/skeleton-generic instead of cisagov/skeleton-python-library
  2. It is a repository trying to store both documentation about our development process and the tools that are used

Moving the tooling into its own repository would allow it to be configured as a typical Python package, which would allow for our CI/CD pipeline to be implemented as it typically would for such a project. This will make it easier to add new tooling, eliminate duplicate code between tools, and ensure that testing is done automatically.

@jsf9k
Copy link
Member

jsf9k commented Oct 29, 2020

I wholeheartedly support this change.

@hillaryj
Copy link
Contributor

hillaryj commented Dec 1, 2020

I've created a new skeleton-python-library-based repo at https://github.com/cisagov/development-tools

@jsf9k
Copy link
Member

jsf9k commented Dec 1, 2020

I've created a new skeleton-python-library-based repo at https://github.com/cisagov/development-tools

I don't think this was the intent. We wanted to move each development tool to its own repo so we can apply all our CI machinery to it.

jsf9k added a commit that referenced this issue Apr 13, 2022
Since this Python module doesn't use a standard src-layout, setuptools
gets confused and is unable to locate the packages to be included.
Since this "Python module" is really just a collection of scripts, we
can tell setuptools to restrict itself to project_setup/scripts.

This is yet another reason why #33 is a good idea.
@jsf9k jsf9k mentioned this issue Apr 13, 2022
6 tasks
jsf9k added a commit that referenced this issue Apr 19, 2022
Since this Python module doesn't use a standard src-layout, setuptools
gets confused and is unable to locate the packages to be included.
Since this "Python module" is really just a collection of scripts, we
can tell setuptools to restrict itself to project_setup/scripts.

This is yet another reason why #33 is a good idea.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants