Skip to content

Rename django-idom to reactpy-django #131

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

Merged
merged 15 commits into from
Mar 30, 2023

Conversation

Archmonger
Copy link
Contributor

Description

Performs any changes needed to rename from idom to reactpy.

Checklist:

Please update this checklist as you complete each item:

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

@Archmonger Archmonger marked this pull request as draft March 1, 2023 23:52
@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 9, 2023

Couple of things are needed for these tests to pass

  1. reactpy 1.0.0 release for parity to idom
    • Why did we revert versions when renaming the package...?
  2. stub repo for
    • reactpy-router
    • django-reactpy (or reactpy-django if you want to rename)
    • reactpy-jupyter
    • reactpy-dash
  3. reactive-python/django group

@rmorshea
Copy link
Contributor

rmorshea commented Mar 9, 2023

I guess I figured that if we wanted to release a 1.0 version of ReactPy we'd need to remove the existing tag. Releasing a 0.45.0 version was mostly a result of me rushing to get a release out after I cleared out the previous releases on PyPI without knowing the consequences.

@rmorshea
Copy link
Contributor

rmorshea commented Mar 9, 2023

Let's begin all names with reactpy- for the sake of consistency this go round. Also, why do we need stub repos? Can't we just rehome this repo?

@rmorshea
Copy link
Contributor

rmorshea commented Mar 9, 2023

Ok I see. I think we can merge despite the docs build failing. We'll just rehome the repo after merging and then rerun the tests.

@Archmonger
Copy link
Contributor Author

Can we re-release ReactPy as 1.0.0?

@rmorshea
Copy link
Contributor

@reactpy/client has been released. You should be able to use this without any changes. The next release of the client (assuming there's nothing wrong with v0.1.0) will be the typescript rewrite.

@Archmonger Archmonger changed the title Rename idom to reactpy Rename django-idom to reactpy-django Mar 15, 2023
@Archmonger
Copy link
Contributor Author

The version number regressions of the JS and Python packages are really unnatural.

@rmorshea
Copy link
Contributor

The zero version on the Python package is temporary. I'm working on publishing a 1.0 release momentarily.

@rmorshea
Copy link
Contributor

v1.0 of reactpy Python lib had been released.

@rmorshea
Copy link
Contributor

rmorshea commented Mar 21, 2023

@Archmonger, because GitHub aggressively strips all style from inline HTML there is no way to copy-paste a common markdown header to all our repos with a simple "ReactPy" to "ReactPy " title change and have it look like landscape SVG logo. From what I can tell, if you want the heading to look like the landscape logo on the main repo you're going to have to copy the SVG file and save a modified version in this repo.

@rmorshea
Copy link
Contributor

rmorshea commented Mar 21, 2023

The only alternative I can think of would be to do something like:

# <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" alt="ReactPy Logo" style="height: 2rem; vertical-align: text-bottom" /> ReactPy

image

Since for some reason img elements seem to allow inline style.

The current logo doesn't really work well at this scale, but perhaps the best option for right now.

@Archmonger
Copy link
Contributor Author

By landscape, do you mean center justified?

@rmorshea
Copy link
Contributor

By landscape I mean this style of logo.

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 22, 2023

I've done something similar using the align image property in the past.

For ReactPy Core...

# ReactPy <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" align="left" height="40"/>

ReactPy

For the Django variant...

# ReactPy Django <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" align="left" height="40"/>

ReactPy Django

@rmorshea
Copy link
Contributor

Let's go with the logo setup you have there. After that I think this LGTM.

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 28, 2023

The tagline (Reactive user interfaces with pure Python) didn't really have a good place with the new readme design, so I opted to remove it. I think we should just keep that text in the github sidebar moving forward.

Also there's no clean way to get a centered header while retaining the logo + text. All the solutions are too messy.

Take a look at the design here: https://github.com/Archmonger/django-idom/tree/django-reactpy

@rmorshea
Copy link
Contributor

do you think we need the backends table here?

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 28, 2023

Not from a technical standpoint, but it's free advertising that doesn't feel like advertising.

The more click-throughs we get, the more we can snowball our overall popularity.


Also, since our docs get auto-published, I think I might revert the problematic docs URLs in this PR

@rmorshea
Copy link
Contributor

I was planning to rehome the repo right after merging so perhaps we could leave the urls as is.

@Archmonger
Copy link
Contributor Author

It's very little extra effort to do a follow up PR to change URLs.

We're already seeing some instances of confusion on the IDOM core docs.

Copy link
Contributor

@rmorshea rmorshea left a comment

Choose a reason for hiding this comment

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

I'm good with things as they are so approving. feel free to make those url changes though.

@rmorshea rmorshea marked this pull request as ready for review March 29, 2023 23:26
@rmorshea
Copy link
Contributor

Good to merge?

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 30, 2023

That last commit revealed some holes in my link checking workflow.

Since the README and CHANGELOG aren't in the docs directory they aren't getting checked.

Also one more thing I want to revert is maintaining the idom name in the legacy changelog descriptions.

@rmorshea
Copy link
Contributor

Ok, just at me when it's ready and I'll merge/rehome.

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 30, 2023

Since I didn't revert any reactpy-django references in the docs, I think we should repo transfer and rename before merging this PR to prevent broken docs links.

Also, our readme logo solution doesn't play well with mkdocs so I might have to do some changes to make that work.

@Archmonger
Copy link
Contributor Author

Archmonger commented Mar 30, 2023

@rmorshea The docs expect to be built with a github.io page of reactive-python.github.io/reactpy-django.

We should move and rename the repo before merging, otherwise we'll end up with completely inaccessible and broken docs.

This PR is otherwise ready to merge.

@Archmonger Archmonger merged commit 2113a57 into reactive-python:main Mar 30, 2023
@Archmonger Archmonger deleted the django-reactpy branch March 30, 2023 01:41
@rmorshea
Copy link
Contributor

LGTM!

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.

2 participants