Build FABulous with setuptools #110

EverythingElseWasAlreadyTaken · 2023-09-08T13:15:32Z

I've refactored FABulous to build it with setuptools.

This would allow us to publish FABulous to PyPI.
I've already prepared a little POC and published it on TestPyPI:
https://test.pypi.org/project/FABulous-FPGA/

It was neccessary to rename the package ot FABulous-FPGA, since there is already a fabulous package on PyPI.

You can install it with:

$ python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple FABulous-FPGA

The --extra-index-url is needed since some dependencies are not available on TestPyPI.

Afterward, you can use FABulous as command line tool:

$ FABulous -c demo
$ FABulous demo
$ FABulous --script ./demo/FABulous.tcl

KelvinChung2000 · 2023-10-20T11:58:13Z

Can you please resolve the merge conflict? Also, since we are moving to setuptools, maybe we should fix the fasm dependency problem mentioned in #60 ?

KelvinChung2000 · 2023-10-31T10:50:47Z

We had a meeting today, and the following is the summary.

The restructure will affect the current user on how FABulous is being used. As a result, we would like to do a non-silicon-proven stable release so users can track back to the current version. Then, we will merge this pull request. @JakobTernes, please check if anything else needs adding before we can do this. @gatecat, we might need your help as well if we are doing a release.
The FASM fix will be happening later.

EverythingElseWasAlreadyTaken · 2023-11-09T14:00:10Z

We had a meeting today, and the following is the summary.

1. The restructure will affect the current user on how FABulous is being used. As a result, we would like to do a non-silicon-proven stable release so users can track back to the current version. Then, we will merge this pull request. @JakobTernes, please check if anything else needs adding before we can do this. @gatecat, we might need your help as well if we are doing a release.

2. The FASM fix will be happening later.

Rebase is done.

@JakobTernes it would be nice if you could check if your changes are still working, since this is currently not covered by the test workflow.

JakobTernes · 2023-11-09T19:47:26Z

@EverythingElseWasAlreadyTaken Looks good to me, the results I expect are still being produced.

@KelvinChung2000 There is still an issue that was found with geometry generation for termination tiles, but since FABulator (the graphical frontend) is not yet available, in part because of this issue, it does not really make a difference. So a release with the current state of the geometry generation is fine with me, the results of the geometry generation should just be taken with a grain of salt here and there, which will only be relevant once FABulator is public anyways. Maybe one could add a comment (in the readme.md?) about the geometry generation / gui feature still being experimental? If all of this is not an option you can get back to me via email: [email protected]

Cheers

KelvinChung2000 · 2023-11-09T21:05:17Z

Let's leave everything like this for now. When FABulator is done, we can combine this as a single release, and then GUI with the new installation method should make better sense than merging this now.

KelvinChung2000 · 2024-02-22T14:27:25Z

I have started a new branch called FABulous2.0-development. Can we merge this to that branch, so this is available while we can keep the master as is.

mole99 · 2024-02-22T14:35:50Z

Just a comment: There seem to be a lot of files that have been reformatted (rightfully so!). Maybe we can keep these changes for a PR that introduces a formatter, e.g. black (see here #158) to reduce the noise in the commit history?

EverythingElseWasAlreadyTaken · 2024-02-26T13:43:03Z

I have started a new branch called FABulous2.0-development. Can we merge this to that branch, so this is available while we can keep the master as is.

Okay, I'll move the PR to the dev branch and rebase it the next days. 👍

EverythingElseWasAlreadyTaken · 2024-02-26T13:47:15Z

Just a comment: There seem to be a lot of files that have been reformatted (rightfully so!). Maybe we can keep these changes for a PR that introduces a formatter, e.g. black (see here #158) to reduce the noise in the commit history?

Yes, I tried to fix the most linter issues, at least for every file I've touched.
This still needs some work, but fixes a lot of smaller stuff.

#163 is a great idea! :)

mole99 · 2024-02-26T13:58:50Z

Thank you! And maybe wait for your rebase until #163 is in master and dev is rebased on top :D

EverythingElseWasAlreadyTaken · 2024-04-24T10:49:55Z

Is there any progress on #163?

Or maybe we could somehow bring this PR forward to merge it in the 2.0 branch?
It would be nice to have this material as a common ground for my future developments. :)

mole99 · 2024-04-27T09:04:36Z

#163 has been merged into FABulous2.0-development, so if you build on top of that, I think this PR can also be merged into the 2.0 branch 👍

Is that correct, @KelvinChung2000? Also, maybe it makes sense to lock the master branch so that no one accidentally pushes to it since development now happens on the 2.0 branch?

mole99 · 2024-04-27T09:18:47Z

I'm thinking about whether the FABulous2.0-development branch is really necessary once this PR has been merged: Users can simply install stable releases from PyPI. Developers target the master branch for new features and open a PR. Once the CI runs through and no regressions are detected, the code can be merged. Whenever enough features have accumulated, a new release can be made on PyPI. Or you could do automatic releases for each new version increment, since the master branch should always be in a stable state.

This would be similar to what we do for https://github.com/efabless/cace

I believe it makes sense to target incremental improvements and not major 2.0, 3.0, etc. releases, as it often takes a long time for users to actually receive improvements. Because the issue with such releases is always: when are they considered done?

KelvinChung2000 · 2024-04-27T12:02:09Z

Yes, this is my plan. Do a release for the current master, or actually, releasing the version used in the workshop (I don't know are there any difference between them). Once the release is done all the development will happen in master again.

mole99 · 2024-04-27T12:33:58Z

Awesome, looking forward to it!

In preparation for packaging FABulous with setuptools, we migrate FABulous to a so-called "flat-layout". This means we add a subfolder FABulous and move all code sources there. Signed-off-by: Jonas K. <[email protected]>

Signed-off-by: Jonas K. <[email protected]>

Automatically sets the fabulousRoot path if no FAB_ROOT env var is specified. Add Python interpreter path in file header. Add main() function. Signed-off-by: Jonas K. <[email protected]>

EverythingElseWasAlreadyTaken · 2024-05-07T12:15:16Z

@KelvinChung2000 @mole99 Rebase is done now. Tests are all running without any issues. Would be nice if you could review the changes and merge it into the 2.0-dev branch.

I'll do another cleanup PR later.
For now, I've removed the most cosmetic changes from this PR, since it got too confusing.

Update pyproject.toml to build FABulous package with setuptools. Use setuptools-scm for autoamtic project version generation. Add FABulous as package script to make it callable directlty from shell. Add bit_gen as package script and add main function to it. Update "fabric_gen" github workflow: - Use new FABulous structure - Update external actions Update import statements in all python modules to absolue imports of FABulous modules and and remove unused imports. Update gitignore. Signed-off-by: Jonas K. <[email protected]>

Update documentation to install and use FABulous with the new setup. Signed-off-by: Jonas K. <[email protected]>

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch from 1c5b817 to cd00bdc Compare November 9, 2023 13:53

KelvinChung2000 mentioned this pull request Feb 19, 2024

Package and Publish to PyPI #159

Closed

mole99 mentioned this pull request Mar 11, 2024

Add formatter #163

Merged

EverythingElseWasAlreadyTaken changed the base branch from master to FABulous2.0-development April 24, 2024 10:46

Move sources to FABulous subfolder

2c002c7

In preparation for packaging FABulous with setuptools, we migrate FABulous to a so-called "flat-layout". This means we add a subfolder FABulous and move all code sources there. Signed-off-by: Jonas K. <[email protected]>

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch 3 times, most recently from 6544f55 to 222e817 Compare May 6, 2024 20:09

EverythingElseWasAlreadyTaken mentioned this pull request May 7, 2024

Refactor file paths and imports in FABulous code #173

Closed

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch from 222e817 to e40daf1 Compare May 7, 2024 11:49

EverythingElseWasAlreadyTaken added 2 commits May 7, 2024 14:07

Fix some filepathes

6c386e2

Signed-off-by: Jonas K. <[email protected]>

FABulous: Add auto set for FAB_ROOT env var and add main()

1539ec3

Automatically sets the fabulousRoot path if no FAB_ROOT env var is specified. Add Python interpreter path in file header. Add main() function. Signed-off-by: Jonas K. <[email protected]>

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch from e40daf1 to e4f4412 Compare May 7, 2024 12:08

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch from e4f4412 to 4d2d5ed Compare May 7, 2024 12:38

EverythingElseWasAlreadyTaken added 2 commits May 7, 2024 14:47

docs: Update docs for new project setup

5f64659

Update documentation to install and use FABulous with the new setup. Signed-off-by: Jonas K. <[email protected]>

EverythingElseWasAlreadyTaken force-pushed the WIP/setuptools branch from 4d2d5ed to 5f64659 Compare May 7, 2024 12:48

KelvinChung2000 merged commit ed1f12e into FPGA-Research:FABulous2.0-development May 7, 2024
1 check passed

IAmMarcelJung mentioned this pull request Jul 6, 2024

ERROR: No such command: synth_fabulous (type 'help' for a command overview) #207

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build FABulous with setuptools #110

Build FABulous with setuptools #110

EverythingElseWasAlreadyTaken commented Sep 8, 2023 •

edited

Loading

KelvinChung2000 commented Oct 20, 2023

KelvinChung2000 commented Oct 31, 2023

EverythingElseWasAlreadyTaken commented Nov 9, 2023 •

edited

Loading

JakobTernes commented Nov 9, 2023 •

edited

Loading

KelvinChung2000 commented Nov 9, 2023

KelvinChung2000 commented Feb 22, 2024

mole99 commented Feb 22, 2024

EverythingElseWasAlreadyTaken commented Feb 26, 2024

EverythingElseWasAlreadyTaken commented Feb 26, 2024 •

edited

Loading

mole99 commented Feb 26, 2024

EverythingElseWasAlreadyTaken commented Apr 24, 2024

mole99 commented Apr 27, 2024

mole99 commented Apr 27, 2024

KelvinChung2000 commented Apr 27, 2024

mole99 commented Apr 27, 2024

EverythingElseWasAlreadyTaken commented May 7, 2024

Build FABulous with setuptools #110

Build FABulous with setuptools #110

Conversation

EverythingElseWasAlreadyTaken commented Sep 8, 2023 • edited Loading

KelvinChung2000 commented Oct 20, 2023

KelvinChung2000 commented Oct 31, 2023

EverythingElseWasAlreadyTaken commented Nov 9, 2023 • edited Loading

JakobTernes commented Nov 9, 2023 • edited Loading

KelvinChung2000 commented Nov 9, 2023

KelvinChung2000 commented Feb 22, 2024

mole99 commented Feb 22, 2024

EverythingElseWasAlreadyTaken commented Feb 26, 2024

EverythingElseWasAlreadyTaken commented Feb 26, 2024 • edited Loading

mole99 commented Feb 26, 2024

EverythingElseWasAlreadyTaken commented Apr 24, 2024

mole99 commented Apr 27, 2024

mole99 commented Apr 27, 2024

KelvinChung2000 commented Apr 27, 2024

mole99 commented Apr 27, 2024

EverythingElseWasAlreadyTaken commented May 7, 2024

EverythingElseWasAlreadyTaken commented Sep 8, 2023 •

edited

Loading

EverythingElseWasAlreadyTaken commented Nov 9, 2023 •

edited

Loading

JakobTernes commented Nov 9, 2023 •

edited

Loading

EverythingElseWasAlreadyTaken commented Feb 26, 2024 •

edited

Loading