Skip to main content

A reusable Django App for importing, updating, and managing structured occupation data.

Project description

PyPI Travis Codecov Documentation Supported Python versions License

django-occupations is a reusable Django App for importing, updating, and managing structured occupation data.

Overview

The structure of this data is currently based primarily on the US Federal Government’s Standard Occupational Classification (SOC) system, but in the future we aspire to support other structured occupation sources. The US Federal Government’s Office of Management and Budget is responsible for maintaining the Standard Occupational Classification (SOC) system. For more information on SOC, please visit https://www.bls.gov/soc/ or https://www.bls.gov/soc/2018/soc_2018_manual.pdf or https://www.bls.gov/soc/2018/soc_2018_definitions.pdf and https://www.bls.gov/soc/2018/soc_structure_2018.pdf

Quick start

  1. Add “django_occupations” to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        'django_occupations',
    ]
  2. Include the django-occupations URLconf in your project urls.py like this:

    path('occupations/', include('django_occupations.urls')),
  3. Run python manage.py migrate to create the django-occupations models.

  4. Start the development server and visit http://127.0.0.1:8000/admin/ to view or edit occupation data (you’ll need the Admin app enabled).

Roadmap

  • Update documentation

  • Add model relationships

  • Add slug fields for URLs

  • Add test coverage

  • Add management command to pull the latest SOC data

  • Add latest SOC data to version control and add a migration to populate data from SOC data

  • Add management command to update SOC Direct Match Titles

  • Decide how to handle when SOC removes certain occupations? Merge into others? Orphan them? Note the date they were deprecated?

  • Clean up some lingering references to edX that no longer make sense (this repo was set up using an edX-authored cookiecutter https://github.com/edx/edx-cookiecutters/tree/master/cookiecutter-django-app )

Documentation

(TODO: Set up documentation)

## Data Policy We use SOC 6-digit codes, but omit the hypen that SOC puts between the 2nd and 3rd digit

For Maintainers

To publish a new release: 1. Update the version number in the application module’s __init__.py file, update CHANGELOG.rst accordingly, and run python setup.py tag 2. Generate distributions using python setup.py sdist bdist_wheel (based on the instructions at https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives) 3. Use twine to update PyPi with python -m twine upload dist/*

License

The code in this repository is licensed under the Apache Software License 2.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome. Please read How To Contribute for details. Even though they were written with edx-platform in mind, we are happy to invite contributions using the same guidelines.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email hello@careervillage.org.

Getting Help

If you’re having trouble, please comment in the Github Issues for this repo or contact us at hello@careervillage.org

Change Log

Unreleased

Refer to the “Roadmap” section of the README.

[0.2.2] 2021-02-10

  • Makes the ONetAlternateTitles-to-SOCOccupations relationship many-to-many. This better matches the ONET taxonomy.

  • You must migrate after upgrading.

[0.2.1] 2020-06-19

  • Adds name field to SOCHighLevelAggregationGroup model.

  • Removes directtitlematch model.

  • You must migrate after upgrading.

[0.2.0] 2020-06-13

  • Adds ONet models for Occupations and Alternate Titles.

  • You must migrate after upgrading.

[0.1.0] 2020-06-06

  • First release on PyPI.

  • Defines SOC models.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-occupations-0.2.2.tar.gz (16.5 kB view hashes)

Uploaded source

Built Distribution

django_occupations-0.2.2-py2.py3-none-any.whl (17.9 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page