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

rename idom to reactpy #892

Merged
merged 4 commits into from
Feb 26, 2023
Merged

rename idom to reactpy #892

merged 4 commits into from
Feb 26, 2023

Conversation

rmorshea
Copy link
Collaborator

closes: #888

Checklist

Please update this checklist as you complete each item:

  • Tests have been included for all bug fixes or added functionality.
  • The changelog.rst has been updated with any significant changes.
  • GitHub Issues which may be closed by this Pull Request have been linked.

@rmorshea rmorshea force-pushed the reactpy branch 3 times, most recently from 7a1c1de to fce5cc0 Compare January 28, 2023 19:30
@rmorshea
Copy link
Collaborator Author

There's a number of different png and gif files that will need to be updated to use the ReactPy name before this can go in. I have intentionally left the names of those files unchanged so they can be more easily found by searching for files with IDOM in their names.

@Archmonger
Copy link
Contributor

I am going to begin work on the new docs based off import paths in this PR

@rmorshea rmorshea force-pushed the reactpy branch 13 times, most recently from 6bfdc82 to ea07129 Compare February 24, 2023 07:51
@rmorshea
Copy link
Collaborator Author

@Archmonger, assuming no other changes are needed, I think we're ready to release 1.0 and execute the rename.
image

@Archmonger
Copy link
Contributor

Archmonger commented Feb 24, 2023

  • docs\source\guides\getting-started\_static\embed-reactpy-view\main.py contains IdomView
  • src\idom\_client\idom-logo-square-small.svg has a attribute of sodipodi:docname="idom-logo-square-small.svg"
  • src\idom\_client\index.html uses src="/_idom/assets/index.a2011453.js"
  • src\idom\_client\index.html.inline.0.js.map contains several hrefs to _idom/*

@rmorshea
Copy link
Collaborator Author

rmorshea commented Feb 25, 2023

@Archmonger I think this is ready to go. The only thing that will be left to do after this is to recreate two gifs that can't be recreated until we release.

@rmorshea rmorshea marked this pull request as ready for review February 25, 2023 22:44
Copy link
Contributor

@Archmonger Archmonger left a comment

Choose a reason for hiding this comment

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

That was a long read 😅

The main nitpicks I have are related to wordsmithing the readme to increase information density, reduce jargon usage, and increase clarity.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
__author__ = "idom-team"
__version__ = "1.0.0-a6" # DO NOT MODIFY
__author__ = "reactive-python"
__version__ = "1.0.0-a5" # DO NOT MODIFY
Copy link
Contributor

@Archmonger Archmonger Feb 25, 2023

Choose a reason for hiding this comment

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

accidental __version__ revert?

@rmorshea
Copy link
Collaborator Author

I think I condensed it down to one paragraph:

ReactPy is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components which look and behave similarly to this found in ReactJS. Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions. It has you covered whether you need to run a full blown application with a standalone server, or simply want try things out in a Jupyter Notebook.

@Archmonger
Copy link
Contributor

Archmonger commented Feb 26, 2023

Minor wordsmithing on the first few sentences:

ReactPy is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components which look and behave similar to ReactJS equivalents. Designed with simplicity in mind, ReactPy can be used by those with minimal web development experience while also being powerful enough to grow with your ambitions.

Last sentence becomes unneeded if we're going for a hyper-minimal summary. But if we're keeping it, then it'll need a new line.

ReactPy has you covered whether you need to run a full-blown application with a standalone server, or simply want try things out in a Jupyter Notebook.

@rmorshea rmorshea merged commit 3dfb8f1 into main Feb 26, 2023
@rmorshea rmorshea deleted the reactpy branch February 26, 2023 20:08
by those without web development experience while also being powerful enough to grow
with your ambitions.

<table>
Copy link
Contributor

Choose a reason for hiding this comment

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

Something I'm now realizing, why are we using HTML tables instead of markdown tables? They should accomplish the same thing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

IMO, the md table was quite hard to read in raw text with all the links.

Comment on lines +12 to +13
<th>Supported Servers</th>
<th>Supported Integrations</th>
Copy link
Contributor

@Archmonger Archmonger Feb 26, 2023

Choose a reason for hiding this comment

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

We should be consistent about our usage of verbiage. ASGI Python Frameworks are not servers. The word server only applies to things like hypercorn, uvicorn, and gunicorn.

  • From the perspective of IDOM, they are backends.
  • From the perspective of those packages, they are web frameworks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about “built-in backends” and “supported frameworks”?

Copy link
Contributor

Choose a reason for hiding this comment

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

Neither option gives a good indication of why we separate these two categories. Maybe we say something like

ReactPy Backends / External ReactPy Backends

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.

Rename "IDOM" to "ReactPy"
2 participants