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.

Sign up for GitHub

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

Jump to bottom

Use editable install for development #123

Merged
merged 3 commits into from
Oct 14, 2022
Merged

Use editable install for development #123

merged 3 commits into from
Oct 14, 2022

Conversation

NoR8quoh1r
Copy link
Contributor

Meta: Use editable install for development

Description

Update the install instructions Readme, including a description on how to use editable installs.
Remove redundant manual package include code.

Checklist

Please read and execute the following:

  • My code follows the coding guidelines of this project
  • My PR title is following the contribution guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I ran Black to format my code

Code of Conduct

By submitting this issue, you agree to follow our Code of Conduct:

@NoR8quoh1r
Update install instructions
7498d4a 
Submodules have been removed, get rid of their mention in the install
instruction.
Use editable install of faebryk, this needs setuptools >= 64, add it to
requirements.
Show optional usage of venv.
@NoR8quoh1r
Remove dependencies from requirements.txt
60d9645 
Since:
 * the package contains the dependencies
 * we do an editable install for development
 * we currently don't fix any specific versions of our dependencies
 we can get rid of them in requirements.txt.
@NoR8quoh1r
Get rid of manual adjustment of sys.path
d25bc55 
When faebryk is installed, e.g. via an editable install,
adding the path to faebryk manually is not necessary, so get rid of
that.
@IoannisP-ITENG IoannisP-ITENG merged commit 43fe464 into faebryk:main Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IoannisP-ITENG IoannisP-ITENG IoannisP-ITENG approved these changes

@ruben-iteng ruben-iteng Awaiting requested review from ruben-iteng ruben-iteng is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@NoR8quoh1r @IoannisP-ITENG