pyPreservicaGov


NamepyPreservicaGov JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://pypreservicagov.readthedocs.io/
SummaryPython Library For Harvesting Modern.Gov Records into Preservica for Long Term Preservation
upload_time2023-10-12 16:37:01
maintainer
docs_urlNone
authorJames Carr
requires_python
licenseApache License 2.0
keywords preservica api preservation modern.gov civica
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyPreservica.Gov

Python Module For Harvesting public Modern.Gov Committee and Meeting Records into Preservica for Long Term Preservation.

pyPreservica.Gov is a Python Module which allows Preservica users to automatically harvest public records from the 
Civica Modern.Gov Content Management system directly into a Preservica Long Term Digital Preservation platform


## Usage

Once installed you can run pyPreservica.Gov directly from the command line

        $ python -m  pyPreservicaGov

The first time the module is run, it will create a credentials.properties file in the local directory and then exit

Edit the credentials.properties, the first section should contain your Preservica username, password and hostname of
the Preservica system you would like to connect to.

The second section contains the security tag which should be assigned to the records as they are ingested. For example 
records which can be published immediately on the Preservica access portal should be set to "public".

The site_name parameter should point to the URL of the Modern.Gov system you would like to harvest.

parent.folder should be the UUID of the Preservica collection the Committee folders will be ingested into. 

The committee.FromDate and committee.ToDate parameters specify the date range of meetings which will be harvested.
    
    [credentials]
    username=test@test.com
    password=1234567
    server=uk.preservica.com
    
    [Modern.Gov]
    security.tag=open
    site_name=https://democracy.local_authority.gov.uk/
    parent.folder=372d2881-7cce-4c2e-99f7-386c3cf4a922
    committee.FromDate=01/01/1980
    committee.ToDate=01/01/2024


Once the credentials.properties has been updated you can run pyPreservica.Gov again directly from the command line
to start the harvest process.

        $ python -m  pyPreservicaGov


## License

The package is available as open source under the terms of the Apache License 2.0


## Installation

pyPreservica.Gov is available from the Python Package Index (PyPI)

https://pypi.org/project/pyPreservicaGov/

To install pyPreservica.Gov, simply run this simple command in your terminal of choice:


    $ pip install pyPreservica.Gov






            

Raw data

            {
    "_id": null,
    "home_page": "https://pypreservicagov.readthedocs.io/",
    "name": "pyPreservicaGov",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Preservica API Preservation Modern.Gov Civica",
    "author": "James Carr",
    "author_email": "drjamescarr@gmail.com",
    "download_url": "",
    "platform": null,
    "description": "# pyPreservica.Gov\n\nPython Module For Harvesting public Modern.Gov Committee and Meeting Records into Preservica for Long Term Preservation.\n\npyPreservica.Gov is a Python Module which allows Preservica users to automatically harvest public records from the \nCivica Modern.Gov Content Management system directly into a Preservica Long Term Digital Preservation platform\n\n\n## Usage\n\nOnce installed you can run pyPreservica.Gov directly from the command line\n\n        $ python -m  pyPreservicaGov\n\nThe first time the module is run, it will create a credentials.properties file in the local directory and then exit\n\nEdit the credentials.properties, the first section should contain your Preservica username, password and hostname of\nthe Preservica system you would like to connect to.\n\nThe second section contains the security tag which should be assigned to the records as they are ingested. For example \nrecords which can be published immediately on the Preservica access portal should be set to \"public\".\n\nThe site_name parameter should point to the URL of the Modern.Gov system you would like to harvest.\n\nparent.folder should be the UUID of the Preservica collection the Committee folders will be ingested into. \n\nThe committee.FromDate and committee.ToDate parameters specify the date range of meetings which will be harvested.\n    \n    [credentials]\n    username=test@test.com\n    password=1234567\n    server=uk.preservica.com\n    \n    [Modern.Gov]\n    security.tag=open\n    site_name=https://democracy.local_authority.gov.uk/\n    parent.folder=372d2881-7cce-4c2e-99f7-386c3cf4a922\n    committee.FromDate=01/01/1980\n    committee.ToDate=01/01/2024\n\n\nOnce the credentials.properties has been updated you can run pyPreservica.Gov again directly from the command line\nto start the harvest process.\n\n        $ python -m  pyPreservicaGov\n\n\n## License\n\nThe package is available as open source under the terms of the Apache License 2.0\n\n\n## Installation\n\npyPreservica.Gov is available from the Python Package Index (PyPI)\n\nhttps://pypi.org/project/pyPreservicaGov/\n\nTo install pyPreservica.Gov, simply run this simple command in your terminal of choice:\n\n\n    $ pip install pyPreservica.Gov\n\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Python Library For Harvesting Modern.Gov Records into Preservica for Long Term Preservation",
    "version": "1.0.1",
    "project_urls": {
        "Discussion Forum": "https://groups.google.com/g/pyPreservicaGov",
        "Documentation": "https://pypreservicagov.readthedocs.io/",
        "Homepage": "https://pypreservicagov.readthedocs.io/",
        "Source": "https://github.com/carj/pyPreservica.Gov"
    },
    "split_keywords": [
        "preservica",
        "api",
        "preservation",
        "modern.gov",
        "civica"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1d76f82c175fbf9034caa60373b25f52c0ef31dc4a54b6ee266980da1b37745",
                "md5": "f524459eca6aa632d16860e7c9d3aee3",
                "sha256": "55889f2db01e6ce49940952048c5794948b0d61bec9180f25fa69b4922b89117"
            },
            "downloads": -1,
            "filename": "pyPreservicaGov-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f524459eca6aa632d16860e7c9d3aee3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 28428,
            "upload_time": "2023-10-12T16:37:01",
            "upload_time_iso_8601": "2023-10-12T16:37:01.634733Z",
            "url": "https://files.pythonhosted.org/packages/a1/d7/6f82c175fbf9034caa60373b25f52c0ef31dc4a54b6ee266980da1b37745/pyPreservicaGov-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-12 16:37:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "carj",
    "github_project": "pyPreservica.Gov",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pypreservicagov"
}
        
Elapsed time: 3.73127s