Skip to content

Commit 055b253

Browse files
committed
Reescribe el README en español: descripción real del theme en lugar del scaffold
1 parent ff4ab8b commit 055b253

1 file changed

Lines changed: 37 additions & 98 deletions

File tree

README.md

Lines changed: 37 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,60 @@
1-
[![Tests](https://github.com/AlenCarbajal | datosgobar/ckanext-gobar-theme/workflows/Tests/badge.svg?branch=main)](https://github.com/AlenCarbajal | datosgobar/ckanext-gobar-theme/actions)
2-
31
# ckanext-gobar-theme
42

5-
**TODO:** Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!
6-
7-
8-
## Requirements
9-
10-
**TODO:** For example, you might want to mention here which versions of CKAN this
11-
extension works with.
12-
13-
If your extension works across different versions you can add the following table:
14-
15-
Compatibility with core CKAN versions:
16-
17-
| CKAN version | Compatible? |
18-
| --------------- | ------------- |
19-
| 2.6 and earlier | not tested |
20-
| 2.7 | not tested |
21-
| 2.8 | not tested |
22-
| 2.9 | not tested |
23-
24-
Suggested values:
25-
26-
* "yes"
27-
* "not tested" - I can't think of a reason why it wouldn't work
28-
* "not yet" - there is an intention to get it working
29-
* "no"
3+
Theme e identidad visual de los portales de datos abiertos de Datos
4+
Argentina, sobre CKAN 2.11. Es la extensión de presentación de
5+
[portal-andino-v2](https://github.com/datosgobar/portal-andino-v2): un mismo
6+
theme sirve para datos.gob.ar y para los nodos que redistribuyen el stack,
7+
personalizable por configuración sin tocar templates ni código.
308

9+
Funcionalidades:
3110

32-
## Installation
11+
* Home propia: hero con buscador, categorías, datasets más consultados,
12+
organizaciones y franja de la API.
13+
* Header y footer institucionales con navegación fija
14+
(Datasets, Organismos, Temas, Recursos, Series, Acerca).
15+
* Perfiles visuales por nodo vía `ckanext.gobar_theme.profile`
16+
(`nacional` | `apn` | `subnacional` | `base`).
17+
* Páginas institucionales en `/paginas/*`, incluido un formulario de
18+
contacto con envío de mail.
19+
* Sección `/recursos` opcional y nombre configurable para la sección de
20+
organizaciones (por ejemplo "Organismos").
21+
* Faceta de Provincia (a partir de la cobertura espacial de los datasets) y
22+
overrides de traducción sobre CKAN core (por ejemplo "Grupos" → "Temas").
3323

34-
**TODO:** Add any additional install steps to the list below.
35-
For example installing any non-Python dependencies or adding any required
36-
config settings.
24+
La página `/series` no vive acá: la registra
25+
[ckanext-series-explorer](https://github.com/datosgobar/ckanext-series-explorer).
3726

38-
To install ckanext-gobar-theme:
27+
## Instalación
3928

40-
1. Activate your CKAN virtual environment, for example:
29+
```
30+
pip install -e 'git+https://github.com/datosgobar/ckanext-gobar-theme.git@main#egg=ckanext-gobar_theme'
31+
pip install -r requirements.txt
32+
```
4133

42-
. /usr/lib/ckan/default/bin/activate
34+
Agregá `gobar_theme` a `ckan.plugins` en tu archivo de configuración y
35+
reiniciá CKAN:
4336

44-
2. Clone the source and install it on the virtualenv
37+
```
38+
ckan.plugins = gobar_theme
39+
```
4540

46-
git clone https://github.com/AlenCarbajal | datosgobar/ckanext-gobar-theme.git
47-
cd ckanext-gobar-theme
48-
pip install -e .
49-
pip install -r requirements.txt
50-
51-
3. Add `gobar-theme` to the `ckan.plugins` setting in your CKAN
52-
config file (by default the config file is located at
53-
`/etc/ckan/default/ckan.ini`).
54-
55-
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
56-
57-
sudo service apache2 reload
58-
59-
60-
## Config settings
41+
## Configuración
6142

6243
Ver [`docs/personalizacion.md`](docs/personalizacion.md): perfil visual
6344
(`ckanext.gobar_theme.profile`), colores, imagen de fondo, título/subtítulo
6445
de la home, label de "Organizaciones", sección Institucional y logo del
6546
footer, sección /recursos — todo configurable por `.env`/`ckan.ini`, sin
6647
tocar templates ni código.
6748

68-
69-
## Developer installation
70-
71-
To install ckanext-gobar-theme for development, activate your CKAN virtualenv and
72-
do:
73-
74-
git clone https://github.com/AlenCarbajal | datosgobar/ckanext-gobar-theme.git
75-
cd ckanext-gobar-theme
76-
pip install -e .
77-
pip install -r dev-requirements.txt
78-
79-
8049
## Tests
8150

82-
To run the tests, do:
83-
84-
pytest --ckan-ini=test.ini
85-
86-
87-
## Releasing a new version of ckanext-gobar-theme
88-
89-
If ckanext-gobar-theme should be available on PyPI you can follow these steps to publish a new version:
90-
91-
1. Update the version number in the `pyproject.toml` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.
92-
93-
2. Make sure you have the latest version of necessary packages:
94-
95-
pip install --upgrade setuptools wheel twine
96-
97-
3. Create a source and binary distributions of the new version:
98-
99-
python -m build && twine check dist/*
100-
101-
Fix any errors you get.
102-
103-
4. Upload the source distribution to PyPI:
104-
105-
twine upload dist/*
106-
107-
5. Commit any outstanding changes:
108-
109-
git commit -a
110-
git push
111-
112-
6. Tag the new release of the project on GitHub with the version number from
113-
the `setup.py` file. For example if the version number in `setup.py` is
114-
0.0.1 then do:
51+
Dentro de un entorno con CKAN instalado (por ejemplo el contenedor dev de
52+
portal-andino-v2):
11553

116-
git tag 0.0.1
117-
git push --tags
54+
```
55+
pytest --ckan-ini=/srv/app/src/ckan/test-core.ini ckanext/gobar_theme/tests
56+
```
11857

119-
## License
58+
## Licencia
12059

12160
[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

0 commit comments

Comments
 (0)