Skip to content

Commit

Permalink
docs: Clarify spider naming convention
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Sep 16, 2021
1 parent d4e3659 commit 38d8650
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,25 @@ Choose a spider name

Lowercase and join the components below with underscores. Replace any spaces with underscores.

For a jurisdiction-specific publication:
For an access method to a jurisdiction-specific data source:

- Country name. Do not use acronyms, like "uk". If in doubt, follow `ISO 3166-1 <https://en.wikipedia.org/wiki/ISO_3166-1>`__. For example: Kyrgyzstan, not Kyrgyz Republic. For a non-country like the European Union, use the relevant geography, like "europe".
- Subdivision name. Do not use acronyms, like "nsw". Omit the subdivision type, like "state", unless it is typically included, like in Nigeria. If in doubt, follow `ISO 3166-2 <https://en.wikipedia.org/wiki/ISO_3166-2>`__.
- System name, if needed. Acronyms are allowed, like "agetic".
- Country name. Do not use acronyms, like "uk". If in doubt, follow `ISO 3166-1 <https://en.wikipedia.org/wiki/ISO_3166-1>`__. For example: "kyrgyzstan", not "kyrgyz_republic". For a non-country like the European Union, use the relevant geography, like "europe".
- Subdivision name. Do not use acronyms, like "nsw". Omit the subdivision type, like "state", unless it is typically included, like in `Nigeria <https://en.wikipedia.org/wiki/List_of_Nigerian_states_by_population>`__. If in doubt, follow `ISO 3166-2 <https://en.wikipedia.org/wiki/ISO_3166-2>`__.
- System name, if needed. Acronyms are allowed, like "ted".
- Publisher name, if needed. Required if the publisher is not a government.
- Disambiguator, if needed. For example: "historical".
- Access method, if needed: "bulk" or "api".
- OCDS format, if needed: "releases", "records", "release packages" or "record packages".
- OCDS format, if needed: "releases", "records", "release_packages" or "record_packages".

For a multi-jurisdiction publication:
For an access method to a multi-jurisdiction data source:

- Organization name
- Disambiguator

If a component repeats another, you can omit or abbreviate the component, like ``peru_compras`` instead of ``peru_peru_compras``.

It is not required for the name to be minimal. For example, ``uganda_releases`` is allowed even if there is no ``uganda_records``.

If you create a new base class, omit the components that are not shared, and add "base" to the end. For example, the ``afghanistan_packages_base.py`` file contains the base class for the ``afghanistan_record_packages`` and ``afghanistan_release_packages`` spiders.

Choose a base class
Expand Down

0 comments on commit 38d8650

Please sign in to comment.