Skip to content

Commit

Permalink
Use the canonical "udata" naming convention
Browse files Browse the repository at this point in the history
  • Loading branch information
bzg committed Feb 3, 2019
1 parent 007a4c4 commit 553229a
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -2,7 +2,7 @@

**Hello fellow developer/hacker/citizen/peer!**

The uData project welcomes, and depends, on contributions from developers and users in the open source community. Contributions can be made in a number of ways, a few examples are:
The udata project welcomes, and depends, on contributions from developers and users in the open source community. Contributions can be made in a number of ways, a few examples are:

* Code patches via pull requests
* Documentation improvements
Expand Down
28 changes: 14 additions & 14 deletions docs/adapting-settings.md
Expand Up @@ -8,7 +8,7 @@ export UDATA_SETTINGS=/path/to/my/udata.cfg

The configuration file is simply a Python file declaring variables.

uData uses a few Flask extensions and therefore provides all available options for these extensions.
udata uses a few Flask extensions and therefore provides all available options for these extensions.
Most of the time, it tries to provide sane defaults.

## Flask and global behavior options
Expand Down Expand Up @@ -53,7 +53,7 @@ If this is an URL, the content is downloaded on the first terms page display and

**default**: `[]`

A list of enabled uData plugins.
A list of enabled udata plugins.

### THEME

Expand Down Expand Up @@ -145,7 +145,7 @@ List of allowed URL schemes.
**default**: All IANA registered TLDs

List of allowed TLDs.
When using uData on an intranet, you might want to add your own custom TLDs:
When using udata on an intranet, you might want to add your own custom TLDs:

```python
from udata.settings import Defaults
Expand Down Expand Up @@ -334,7 +334,7 @@ The above example will produce:

**default**: `'mongodb://localhost:27017/udata'`

The mongodb database used by uData.
The mongodb database used by udata.
During tests, the test database will use the same name suffixed by `-test`

See [the official Flask-MongoEngine documentation][flask-mongoengine-doc]
Expand All @@ -354,7 +354,7 @@ An optional alternative mongo database used for testing.

## Celery options

By default, uData is configured to use Redis as Celery backend and a customized MongoDB scheduler.
By default, udata is configured to use Redis as Celery backend and a customized MongoDB scheduler.

The defaults are:

Expand All @@ -380,9 +380,9 @@ CELERY_BROKER_URL = 'redis://u:<password>@<host>:<port>'

You can see the full list of Celery options in the [Celery official documentation][celery-doc].

**Note** Celery parameters changed in uData 1.2 because Celery has been upgraded to 4.1.0.
**Note** Celery parameters changed in udata 1.2 because Celery has been upgraded to 4.1.0.
(You can get the change map [here][celery-conf-map]).
uData expect Celery parameters to be upper case and prefixed by `CELERY_` in your `udata.cfg`
udata expect Celery parameters to be upper case and prefixed by `CELERY_` in your `udata.cfg`
and they will be automatically transformed for Celery 4.x:
Example:
- Celery 3.x expected `BROKER_URL` and Celery 4.x expects `broker_url` so you need to change `BROKER_URL` to `CELERY_BROKER_URL` in your settings
Expand All @@ -401,7 +401,7 @@ The default identity used for outgoing mails.

## Flask-OAuthlib options

uData is Oauthlib to provide OAuth2 on the API.
udata is Oauthlib to provide OAuth2 on the API.
The full option list is available in
[the official Flask-OAuthlib documentation][flask-oauthlib-doc]

Expand All @@ -419,7 +419,7 @@ The OAuth2 error page. Do not modify unless you know what you are doing.

## Flask-Cache options

uData uses Flask-Cache to handle cache and use Redis by default.
udata uses Flask-Cache to handle cache and use Redis by default.
You can see the full options list in
[the official Flask-Cache documentation][flask-cache-doc]

Expand All @@ -444,7 +444,7 @@ This activates metrics, this is deactivated for tests

## Flask-FS options

uData use Flask-FS as storage abstraction.
udata use Flask-FS as storage abstraction.

## Flask-CDN options

Expand All @@ -467,11 +467,11 @@ If defined to anything else than a falsy value, theses settings take precedence

Avatar provider used to render user avatars.

uData provides 3 backends:
udata provides 3 backends:

- `internal`: uData renders avatars itself using [pydenticon](http://pydenticon.readthedocs.io)
- `adorable`: uData uses [Adorable Avatars](http://avatars.adorable.io/) to render avatars
- `robohash`: uData uses [Robohash](https://robohash.org/) to render avatars
- `internal`: udata renders avatars itself using [pydenticon](http://pydenticon.readthedocs.io)
- `adorable`: udata uses [Adorable Avatars](http://avatars.adorable.io/) to render avatars
- `robohash`: udata uses [Robohash](https://robohash.org/) to render avatars

### AVATAR_INTERNAL_SIZE

Expand Down
2 changes: 1 addition & 1 deletion docs/administrative-tasks.md
@@ -1,6 +1,6 @@
# Launching tasks

uData provides a command line interface for most of the administrative tasks.
udata provides a command line interface for most of the administrative tasks.

You can get the documentation related to all tasks with:

Expand Down
6 changes: 3 additions & 3 deletions docs/development-environment.md
Expand Up @@ -93,7 +93,7 @@ $ inv widgets-build

## Running the project for the first time

You need to initialize some data before being able to use uData:
You need to initialize some data before being able to use udata:

```shell
# Initialize database, indexes...
Expand All @@ -106,7 +106,7 @@ $ udata licenses https://www.data.gouv.fr/api/1/datasets/licenses
$ inv i18nc
```

You should be to start using and contributing to uData.
You should be to start using and contributing to udata.

## Running the project

Expand All @@ -128,7 +128,7 @@ you can open your browser to <http://localhost:7000>.
Everything should be up and running!

!!! note "Tell us what you think"
You are always welcome to tell us about your experience _installing uData_.
You are always welcome to tell us about your experience _installing udata_.
Get in touch with us via our [Gitter chatroom][Gitter] or by raising a [new issue][] on [GitHub][].

## Common tasks
Expand Down
4 changes: 2 additions & 2 deletions docs/docker-deployment.md
@@ -1,9 +1,9 @@
# Docker deployment

This documents the [Docker][] way to deploy uData.
This documents the [Docker][] way to deploy udata.
If you are intending to perform a classic deployment on a server, you should look at the [Installation section](installation.md).

uData and its extensions are packaged and distributed as [Docker images][].
udata and its extensions are packaged and distributed as [Docker images][].
Head directly to [the dedicated repository][docker-repository] for an up to date documentation and [configuration samples][].

## Developing on your machine
Expand Down
4 changes: 2 additions & 2 deletions docs/extending.md
@@ -1,6 +1,6 @@
# Extending uData
# Extending udata

uData is customizable in many ways, just choose yours.
udata is customizable in many ways, just choose yours.

## Configuration

Expand Down
10 changes: 5 additions & 5 deletions docs/installation.md
Expand Up @@ -23,7 +23,7 @@ total 4
drwxr-xr-x 9 udata udata 4096 Jun 23 05:50 udata
```

You can now log into this account to install uData:
You can now log into this account to install udata:

```shell
$ su - udata
Expand Down Expand Up @@ -84,9 +84,9 @@ $ udata init

## Sample nginx & uWSGI configuration

You can use whatever stack you want to run uData, nginx or Apache 2 as reverse proxy, supervisord + Gunicorn or uWSGI...
You can use whatever stack you want to run udata, nginx or Apache 2 as reverse proxy, supervisord + Gunicorn or uWSGI...

All you need to remember is that uData requires at least 3 services to run:
All you need to remember is that udata requires at least 3 services to run:

- a web frontend using the `udata.wsgi` WSGI entry point.
- a worker service using [celery][]
Expand Down Expand Up @@ -357,7 +357,7 @@ Then create a symlink to activate it:
$ ln -s /etc/nginx/sites-{available,enabled}/data.example.com
```

Before restarting all services to start uData, we need to adjust its configuration
Before restarting all services to start udata, we need to adjust its configuration
and collect static assets to make them available for nginx.

```shell
Expand Down Expand Up @@ -421,7 +421,7 @@ You can now process static assets in the directory declared in the nginx configu
$ udata collect -ni $HOME/public
```

Alright, everything is ready to run uData so logout from the `udata` account and restart nginx and uWSGI:
Alright, everything is ready to run udata so logout from the `udata` account and restart nginx and uWSGI:

```shell
$ service uwsgi restart
Expand Down
2 changes: 1 addition & 1 deletion docs/rdf.md
@@ -1,6 +1,6 @@
# RDF

uData as built-in [RDF][] support allowing to both expose and harvest RDF metadata.
udata as built-in [RDF][] support allowing to both expose and harvest RDF metadata.
It uses the [Data Catalog Vocabulary][dcat] (or [DCAT][]) as base vocabulary.

## Endpoints
Expand Down
2 changes: 1 addition & 1 deletion docs/system-dependencies.md
Expand Up @@ -2,7 +2,7 @@

## Python requirements

uData requires [Python][] 2.7 (installed by default on OSX and many Linux distributions),
udata requires [Python][] 2.7 (installed by default on OSX and many Linux distributions),
its development tools and some libraries to be installed (with their headers).
Most of them might already be installed as they are common development dependencies.
The full dependencies list is:
Expand Down
2 changes: 1 addition & 1 deletion docs/testing-code.md
Expand Up @@ -111,7 +111,7 @@ $ npm -s run test:unit -- --browsers 'IE11 - Win7'
```

!!! note
uData tests ensure the compatibility with IE version(s) [officially supported by Microsoft][ie-support].
udata tests ensure the compatibility with IE version(s) [officially supported by Microsoft][ie-support].
Right now, it’s IE11.

You maybe need to manually close the first time popup on first run.
Expand Down
8 changes: 4 additions & 4 deletions docs/versioning.md
Expand Up @@ -2,11 +2,11 @@

## Versioning process

uData follows [Python PEP 440 on versioning][pep440] to version its published releases.
udata follows [Python PEP 440 on versioning][pep440] to version its published releases.

### Branches management

There is a main branch on the [uData git repository][github], `master`,
There is a main branch on the [udata git repository][github], `master`,
and some maintenance branches `vX.Y`

The `master` is the stable development branch on which:
Expand All @@ -33,11 +33,11 @@ The contents of each version (expected or real) is tracked trough [issues][], [p

## Releasing

uData uses [Bump'R][bumpr] as its release process.
udata uses [Bump'R][bumpr] as its release process.

To create a release, you need to:

- have administrator permission on the uData repository (to allow direct push)
- have administrator permission on the udata repository (to allow direct push)
- have a working development environment up to date with the `master` branch
- have `bumpr` installed

Expand Down
2 changes: 1 addition & 1 deletion udata/utils.py
Expand Up @@ -259,7 +259,7 @@ def faker_provider(provider):
@faker_provider
class UDataProvider(BaseProvider):
'''
A Faker provider for UData missing requirements.
A Faker provider for udata missing requirements.
Might be conributed to upstream Faker project
'''
Expand Down

0 comments on commit 553229a

Please sign in to comment.