search

shayypy / guilded.py

Asynchronous Guilded API wrapper for Python
https://guildedpy.rtfd.io
Other
135 stars 25 forks source link

Added Makefile + development mode #18

Closed ThomasJRyan closed 3 years ago

ThomasJRyan commented 3 years ago

I went and added a Makefile for quickly putting guilded.py into development mode. I added the usage instructions to the README but the basic usage is to create your venv then run make develop.

This allows for any changes to the library code to be reflected back in Python immediately plus make developing simpler

shayypy commented 3 years ago

I think this is a little unnecessary for this package. Kind of just seems like a glorified shortcut to python setup.py develop unless I'm misunderstanding the greater purpose of this PR.

ThomasJRyan commented 3 years ago

A glorified shortcut is a fair description of it, you certainly aren't wrong. The purpose is more of a means to make development easier for anyone coming into it.

Additionally, having the Makefile defined will allow you to build on it later down the road for things such as building the docs and package itself. Having a bunch of scripts to easily move along your development and release process is more long-term thinking than anything else.

shayypy commented 3 years ago

Sphinx has its own makefile in the docs directory. I suppose I could have a make docs, but again it would be a glorified shortcut to cd docs && make html. If I end up needing a makefile for other things down the road, I’d probably just make one then. It’s not much of a hassle to “have it defined”.

ThomasJRyan commented 3 years ago

Very well