# Quetz-frontend
## The Open-Source Server for Conda Packages
<table>
<thead align="center" cellspacing="10">
<tr>
<th colspan="3" align="center" border="">part of mamba-org</th>
</tr>
</thead>
<tbody>
<tr background="#FFF">
<td align="center">Package Manager <a href="https://github.com/mamba-org/mamba">mamba</a></td>
<td align="center">Package Server <a href="https://github.com/mamba-org/quetz">quetz</a></td>
<td align="center">Package Builder <a href="https://github.com/mamba-org/boa">boa</a></td>
</tr>
</tbody>
</table>
[](https://github.com/mamba-org/quetz-frontend/actions)
### Development
First of all, clone quetz and quetz-frontend, create a conda environment using the `environment.yml` in quetz, run quetz and modify its config file.
```bash
# Create an environment
mamba env create -f quetz/environment.yml
mamba activate quetz
mamba install -c conda-forge nodejs=16 yarn=1.22
```
#### Install Quetz in dev mode
```bash
cd quetz
pip install -e .
# Run quetz
quetz run test_quetz --delete --copy-conf ./dev_config.toml --dev --reload
```
Modify the `quetz/test_quetz/config.toml` file to add the client_id, client_secret, github username and the front-end paths.
```bash
[github]
# Register the app here: https://github.com/settings/applications/new
client_id = "id"
client_secret = "secret"
[users]
admins = ["github:username"]
```
#### Install Quetz-Frontend in dev mode
```bash
# build the app
pip install -e .
# Create a link to the quetz folder
quetz-frontend link-frontend --development
```
#### Useful commands
```bash
# Start an already configured quetz deployment in dev mode:
quetz start test_quetz --reload
# Build the Quetz-frontend
yarn run build
# Build the Quetz-Frontend in watch mode
yarn run watch
```
### Disabling extensions
```json
"quetz": {
"extension": true,
"outputDir": "quetz_light_theme/quetzextension",
"themePath": "style/index.css",
"disabledExtensions": ["quetz-theme"]
},
```
### Command line tool
Quetz fronted also comes with a cli to manage extensions
```bash
Usage: quetz-frontend [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.
Commands:
build Build an extension
clean Clean the extensions directory
clean-frontend Clean the Quetz-Frontend
develop Build and install an extension in dev mode
install Build and install an extension
link-frontend Intall the Quetz-Frontend
list List of extensions
paths
watch Watch an extension
```
Raw data
{
"_id": null,
"home_page": "https://github.com/mamba-org/quetz-frontend",
"name": "quetz-frontend",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "quetz,mamba,conda",
"author": "QuantStack",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/31/5a/b79a46131ec00abfe82f23f0097dbf4e2b124869ce0fcba6e0bb90d337dd/quetz-frontend-0.4.1.tar.gz",
"platform": "Linux",
"description": "\n\n# Quetz-frontend\n\n## The Open-Source Server for Conda Packages\n\n<table>\n<thead align=\"center\" cellspacing=\"10\">\n <tr>\n <th colspan=\"3\" align=\"center\" border=\"\">part of mamba-org</th>\n </tr>\n</thead>\n<tbody>\n <tr background=\"#FFF\">\n <td align=\"center\">Package Manager <a href=\"https://github.com/mamba-org/mamba\">mamba</a></td>\n <td align=\"center\">Package Server <a href=\"https://github.com/mamba-org/quetz\">quetz</a></td>\n <td align=\"center\">Package Builder <a href=\"https://github.com/mamba-org/boa\">boa</a></td>\n </tr>\n</tbody>\n</table>\n\n[](https://github.com/mamba-org/quetz-frontend/actions)\n\n### Development\n\nFirst of all, clone quetz and quetz-frontend, create a conda environment using the `environment.yml` in quetz, run quetz and modify its config file.\n\n```bash\n# Create an environment\nmamba env create -f quetz/environment.yml\nmamba activate quetz\nmamba install -c conda-forge nodejs=16 yarn=1.22\n```\n\n#### Install Quetz in dev mode\n\n```bash\ncd quetz\npip install -e .\n\n# Run quetz\nquetz run test_quetz --delete --copy-conf ./dev_config.toml --dev --reload\n```\n\nModify the `quetz/test_quetz/config.toml` file to add the client_id, client_secret, github username and the front-end paths.\n\n```bash\n[github]\n# Register the app here: https://github.com/settings/applications/new\nclient_id = \"id\"\nclient_secret = \"secret\"\n\n[users]\nadmins = [\"github:username\"]\n```\n\n#### Install Quetz-Frontend in dev mode\n\n```bash\n# build the app\npip install -e .\n\n# Create a link to the quetz folder\nquetz-frontend link-frontend --development\n```\n\n#### Useful commands\n\n```bash\n# Start an already configured quetz deployment in dev mode:\nquetz start test_quetz --reload\n\n# Build the Quetz-frontend\nyarn run build\n\n# Build the Quetz-Frontend in watch mode\nyarn run watch\n```\n\n### Disabling extensions\n\n```json\n\"quetz\": {\n \"extension\": true,\n \"outputDir\": \"quetz_light_theme/quetzextension\",\n \"themePath\": \"style/index.css\",\n \"disabledExtensions\": [\"quetz-theme\"]\n },\n```\n\n### Command line tool\n\nQuetz fronted also comes with a cli to manage extensions\n\n```bash\nUsage: quetz-frontend [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --install-completion Install completion for the current shell.\n --show-completion Show completion for the current shell, to copy it or\n customize the installation.\n --help Show this message and exit.\n\nCommands:\n build Build an extension\n clean Clean the extensions directory\n clean-frontend Clean the Quetz-Frontend\n develop Build and install an extension in dev mode\n install Build and install an extension\n link-frontend Intall the Quetz-Frontend\n list List of extensions\n paths\n watch Watch an extension\n\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Quetz frontend as Quetz server extension",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/mamba-org/quetz-frontend"
},
"split_keywords": [
"quetz",
"mamba",
"conda"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96aba0fe9bbd28c685795eb8dfbabe81efb370ebd94c2fb581e0b8a630e61a97",
"md5": "84f75d8f073043a6b7d08e30cc95a919",
"sha256": "63f830d5d244f1a3821731fb4743425ae0cc22e3e8b332e291277081e8a98b5e"
},
"downloads": -1,
"filename": "quetz_frontend-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "84f75d8f073043a6b7d08e30cc95a919",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6288108,
"upload_time": "2023-12-05T23:25:48",
"upload_time_iso_8601": "2023-12-05T23:25:48.255555Z",
"url": "https://files.pythonhosted.org/packages/96/ab/a0fe9bbd28c685795eb8dfbabe81efb370ebd94c2fb581e0b8a630e61a97/quetz_frontend-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "315ab79a46131ec00abfe82f23f0097dbf4e2b124869ce0fcba6e0bb90d337dd",
"md5": "b12711b592d2fa4f89af6701f1fcbd94",
"sha256": "e23fe342fec6c300ed2684eaebde665ff9f916ce4b0a6fbfabddd18d84b6d031"
},
"downloads": -1,
"filename": "quetz-frontend-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "b12711b592d2fa4f89af6701f1fcbd94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4135831,
"upload_time": "2023-12-05T23:25:21",
"upload_time_iso_8601": "2023-12-05T23:25:21.409873Z",
"url": "https://files.pythonhosted.org/packages/31/5a/b79a46131ec00abfe82f23f0097dbf4e2b124869ce0fcba6e0bb90d337dd/quetz-frontend-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 23:25:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mamba-org",
"github_project": "quetz-frontend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "quetz-frontend"
}
JSON
