reactive-python / reactpy-django

It's React, but in Python. Now with Django integration.
https://reactive-python.github.io/reactpy-django/
MIT License
322 stars 18 forks source link

Rename `django-idom` to `reactpy-django` #131

Closed Archmonger closed 1 year ago

Archmonger commented 1 year ago

Description

Performs any changes needed to rename from idom to reactpy.

Checklist:

Please update this checklist as you complete each item:

Archmonger commented 1 year ago

Couple of things are needed for these tests to pass

1) reactpy 1.0.0 release for parity to idom

rmorshea commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Can we re-release ReactPy as 1.0.0?

rmorshea commented 1 year ago

@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 commented 1 year ago

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

rmorshea commented 1 year ago

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

rmorshea commented 1 year ago

v1.0 of reactpy Python lib had been released.

rmorshea commented 1 year ago

@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 commented 1 year ago

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 commented 1 year ago

By landscape, do you mean center justified?

rmorshea commented 1 year ago

By landscape I mean this style of logo.

Archmonger commented 1 year ago

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 commented 1 year ago

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

Archmonger commented 1 year ago

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 commented 1 year ago

do you think we need the backends table here?

Archmonger commented 1 year ago

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 commented 1 year ago

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

Archmonger commented 1 year ago

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.

rmorshea commented 1 year ago

Good to merge?

Archmonger commented 1 year ago

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 commented 1 year ago

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

Archmonger commented 1 year ago

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 commented 1 year ago

@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.

rmorshea commented 1 year ago

LGTM!