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

Invoke commands by Makefile #122

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

priyapahwa
Copy link

This PR closes #108 by including:

  • Make commands for setup and usage
  • Guidelines for installation on Linux distributions

Signed-off-by: priyapahwa [email protected]

<a href="https://github.com/fedora-iot/zezere/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/fedora-iot/zezere.svg?style=for-the-badge" style="max-width:100%;">
</a>
</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason for not using markdown specifically? 🤔

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using regular HTML tags comes in handy while specifying the dimensions of an image. Rest, nothing specific.

django>=2.1
djangorestframework
mod_wsgi-standalone
psycopg2-binary
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what are these for?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going by the common convention to put testing or development requirements in a separate file. The basic idea behind this was to install all developmental dependencies by invoking make commands in that respective directory.

@@ -0,0 +1,43 @@
PYTHON_EXE?=python3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason you're using Makefile for this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Facing issues while setting up a project is quite inevitable. To simplify the process, make commands might be invoked after specifying the tasks to be executed.
The sole purpose was to set the desired python version in the makefile. In my opinion, they make the Makefile cleaner and can be overridden by the user as per the future requirements.

@@ -0,0 +1,4 @@
django>=2.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why create a separate requirements file and not use the project-level one?
This will likely get out of sync.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use the project-level requirements file for sure. No doubt that right now it does not serve any major purpose but as the size of the source code grows with the passage of time, specifying separate dependencies for production and development seems more reasonable. Moreover, in the case of working with unit testing frameworks, installing that in production would be unavailing.

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

Successfully merging this pull request may close these issues.

Guide for getting started as a developer
3 participants