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

Readme update related to pypi #65

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Readme update related to pypi #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5622e1c
readme update related to pypi
ajeety4 Oct 8, 2024
c600d5e
nit: readibility on readme
ajeety4 Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions apache-superset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ very complicated or impossible to do inside HQ Superset.

In this spirit,
- if the change is specific to CommCare HQ, try to implement the
customization in [HQ Superset](https://github.com/dimagi/hq_superset).
customization in [Commcare Analytics](https://github.com/dimagi/hq_superset).
- If the change is not specific to CommCare HQ and is useful to outside
users, try to create a pull request against the upstream
[Apache Superset](https://github.com/apache/superset) repo.
Expand Down Expand Up @@ -289,6 +289,10 @@ the build instructions have remained the same before proceeding.
cd superset-frontend/
npm ci && npm run build
```

> Note: If you see a warning/error for npm and node versions, you can use a tool like
[nvm](https://github.com/nvm-sh/nvm) to install and use the correct version.

- Build translations
```
cd ../
Expand All @@ -306,7 +310,23 @@ the build instructions have remained the same before proceeding.
```
twine upload dist/apache-superset-${latest-dimagi-version}.tar.gz
```
You can refer to 1Password for the PyPI credentials.
You can refer to 1Password for the PyPI API token for dimagi-superset.

You should now be able to use this package inside
https://github.com/dimagi/hq_superset by referring to the release tag.

> Note:
>
> * PyPI package follows the versioning scheme as described
> [here](https://packaging.python.org/en/latest/discussions/versioning/).
> We make any initial customizations on top of Apache upstream version
> and then make a release to PyPI with the same version number. e.g.
> customizations were made on the upstream version `3.1.0` and this
> was released to dimagi-superset PyPI as `3.1.0`.
>
> * If any additional customizations are needed on top of initial
> versions, we are using the post release for numbering i.e.
> `.post<>` as the suffix with N as an incrementing integer. It is
> acknowledged that using the post release is not the best way,
> however it was chosen to keep the version in sync with the upstream
> apache-superset version.
Loading