{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6" ], "description": "overview-upload\n===============\n\nUpload files to an `Overview `__ document\nset.\n\nInstallation\n============\n\nRequires `python3 `__.\n\n``pip3 install overview_upload``, maybe with ``sudo`` in front. That\nwill install a ``overview-upload`` program in your path.\n\nCommand-Line Usage\n==================\n\noverview-upload: upload files\n-----------------------------\n\n``overview-upload --server --token [options] DIRECTORY``\n\nRequired arguments:\n\n- ``SERVER_URL`` is the base URL for the server, which defaults to\n http://localhost:9000 for use with\n `overview-local `__.\n- ``API_TOKEN`` is the access token for a particular document set,\n which you get like this:\n\n 1. Browse to your document set. The URL will look like\n ``https://www.overviewdocs.com/documentsets/123456``.\n 2. Note the document set number, in this case ``123456``\n 3. Browse to\n ``https://www.overviewdocs.com/documentsets/[your number here]/api-tokens``\n and click \"Generate token\".\n\n- ``DIRECTORY`` is a path to the file or directory you want to upload.\n\nOptional arguments:\n\n- ``--skip-duplicate`` (the default), ``--noskip``: skip files that are\n already part of the document set your API token refers to. Files are\n compared by their sha1 hashes, meaning even if you move or rename the\n file it will not be uploaded if the document set already includes it.\n This feature is helpful for synchronizing a local directory with an\n Overview document set; however, it will not delete Overview documents\n corresponding to files you deleted locally.\n- ``--split-by-page``: tell Overview to turn a multi-page file (like a\n PDF or Word document) into several Overview documents.\n- ``--ocr`` (the default), ``--no-ocr``: tell Overview what to do when\n a PDF page has only images but no text. Overview can either try to\n recognize text using\n `Tesseract `__ (which is\n slow and will prevent you from viewing the document set until it\n finishes), or it can assume the page contains no text.\n-- ``create-document-set-with-title``: create a new document set with the\n given title and then add files to it. ``API_TOKEN`` here is one you\n create at http://www.overviewdocs.com/api-tokens or\n http://localhost:9000/api-tokens.\n\nIf you upload a single file, its Overview document title will be its\nfilename, without any directory information. If you upload a directory,\nfilenames will include subdirectory informatin: for instance, if\n``overview-upload /some/path`` uploads ``/some/path/to/file.pdf``, the\nOverview document title will be ``to/file.pdf``.\n\noverview-upload-csv: upload from a CSV manifest\n-----------------------------------------------\n\nGiven a CSV like this:\n\n.. csv-table:: manifest.csv\n :header: id,title,url,field1,field2\n \n 1,doc1.pdf,http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_open_parameters.pdf,some metadata,some more metadata\n 2,doc2.pdf,http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_open_parameters.pdf,more metadata,and even more metadata\n\nYou can upload the referenced files to Overview like this:\n\n``overview-upload-csv --url-field url --title-field title --server https://www.overviewdocs.com``\n\nIf you browse to the document set and add ``field1`` and ``field2`` fields, you\nwill see the values from the CSV.\n\nYou can use ``--local-file-field`` instead of ``--url-field`` to use a field containing paths on your filesystem.\n\noverview-create-document-set: Create an empty document set\n----------------------------------------------------------------\n\nYou can create an empty document set using this incantation:\n\n``overview-create-document-set --server --token [options] \"DOCUMENT SET TITLE\"``\n\nRequired arguments:\n\n- ``SERVER_URL`` is the base URL for the server, which defaults to\n http://localhost:9000 for use with\n `overview-local `__.\n- ``API_TOKEN`` is the *global* access token for creating document sets,\n which you can create at https://www.overviewdocs.com/api-tokens\n\nOptional arguments:\n\n- ``--metadata-schema-field-names``: Fields to display for each document. Example: ``\"Title,Author\"``.\n\nThe program will display an API token you can use to add documents to the new\ndocument set.\n\nAPI usage\n=========\n\nYou can also ``import overview_upload`` from your own Python3 program\nand then use the ``overview_upload.Upload`` class. See the\n``overview-server`` source code for more information.\n\nDeveloping\n==========\n\nReleasing a new version\n-----------------------\n\n0. `Register on\n PyPI `__ and\n create ``~/.pypirc`` with ``[pypi]\\nusername = ...\\npassword = ...``\n1. Update ``version`` in ``setup.py``\n2. ``rm -r dist && ./setup.py sdist``\n3. ``gpg --detach-sign -a dist/*.tar.gz``\n4. ``twine upload dist/*.tar.gz dist/*.asc``\n\nLicense\n=======\n\nThis software is distributed under the terms of the GNU Affero General\nPublic License. See the LICENSE file for details.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/overview/overview-upload-directory", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "overview-upload", "package_url": "https://pypi.org/project/overview-upload/", "platform": "", "project_url": "https://pypi.org/project/overview-upload/", "project_urls": { "Homepage": "https://github.com/overview/overview-upload-directory" }, "release_url": "https://pypi.org/project/overview-upload/0.9.11/", "requires_dist": null, "requires_python": "", "summary": "Upload documents to Overview web server", "version": "0.9.11" }, "last_serial": 3095461, "releases": { "0.9.0": [ { "comment_text": "", "digests": { "md5": "e9915728ef15b875e92e027231716f25", "sha256": "c9302f03308ca8845703954faa367bf0c4ea02d84771531e72e1d6da4590590c" }, "downloads": -1, "filename": "overview_upload-0.9.0.linux-x86_64.tar.gz", "has_sig": true, "md5_digest": "e9915728ef15b875e92e027231716f25", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8320, "upload_time": "2017-06-08T15:07:44", "url": "https://files.pythonhosted.org/packages/a4/42/565b5c28bcc35abc24a87d6b0e93492f19651d9f6912fc480903255a5b45/overview_upload-0.9.0.linux-x86_64.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "0dad8bc6709cad76079a726274051084", "sha256": "bdf300825ad4901e1dab61053b85e0fdd81316f66a2fd8a44f21b946bcd8bd08" }, "downloads": -1, "filename": "overview_upload-0.9.1.tar.gz", "has_sig": true, "md5_digest": "0dad8bc6709cad76079a726274051084", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6150, "upload_time": "2017-06-08T15:39:37", "url": "https://files.pythonhosted.org/packages/c1/35/d3cfdb77f0ae21d8f232e348fce42e71d91f233f2c2607c656ee987cac1c/overview_upload-0.9.1.tar.gz" } ], "0.9.10": [ { "comment_text": "", "digests": { "md5": "1333f4e8406e55d6ef8fa656ba07a58d", "sha256": "9a12edecadf4c8eef4a30acfccb9f02027f5bdd405a914c0fc50edbce891bbd4" }, "downloads": -1, "filename": "overview_upload-0.9.10.tar.gz", "has_sig": true, "md5_digest": "1333f4e8406e55d6ef8fa656ba07a58d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11390, "upload_time": "2017-08-03T01:54:44", "url": "https://files.pythonhosted.org/packages/4b/e6/6f900b70a26c9b1e0d0344d866c693da51b241b94ccf30b3058f3234bae0/overview_upload-0.9.10.tar.gz" } ], "0.9.11": [ { "comment_text": "", "digests": { "md5": "358abb5ea78c2e50a50b988f23888a6f", "sha256": "4575d8e43637f8c9015427594520cc5fd5cf1e573367968fca7d22f2ab907864" }, "downloads": -1, "filename": "overview_upload-0.9.11.tar.gz", "has_sig": true, "md5_digest": "358abb5ea78c2e50a50b988f23888a6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11693, "upload_time": "2017-08-14T13:31:07", "url": "https://files.pythonhosted.org/packages/67/8f/50fd63ea6aaf3d54db0ca2263615c79252052f1dc96ff8f4ed81b22087ca/overview_upload-0.9.11.tar.gz" } ], "0.9.3": [ { "comment_text": "", "digests": { "md5": "65ea5f22cbba2a1a2dfee43c052c064b", "sha256": "5aa973132bcde9ba5e0bd8ad9cce0fea24cfc9942cb23435da903a10f640a6b1" }, "downloads": -1, "filename": "overview_upload-0.9.3.tar.gz", "has_sig": true, "md5_digest": "65ea5f22cbba2a1a2dfee43c052c064b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6650, "upload_time": "2017-06-08T17:20:58", "url": "https://files.pythonhosted.org/packages/75/b2/eb39b2ac220f77f29c7cc117af4962dfcd8ad00aff5a180485b7158f8038/overview_upload-0.9.3.tar.gz" } ], "0.9.4": [ { "comment_text": "", "digests": { "md5": "2dcae19d3ebef2df6c2d18219212e5cd", "sha256": "8c9f4ec40a698df9a59bfde88ce1b2958af4a298934c859795d5c4138d9fca60" }, "downloads": -1, "filename": "overview_upload-0.9.4.tar.gz", "has_sig": true, "md5_digest": "2dcae19d3ebef2df6c2d18219212e5cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8186, "upload_time": "2017-06-08T20:04:02", "url": "https://files.pythonhosted.org/packages/5a/01/6c62b896a3035432953d17074cbe3d3aa14a72cb156c61acba049e5ab7bf/overview_upload-0.9.4.tar.gz" } ], "0.9.5": [ { "comment_text": "", "digests": { "md5": "b97515f76948f3d115cab8b75bcfa4d1", "sha256": "41555b9136d8076b85718b462f60b8372a24d8584f30ced364e3f7e5492dbd5b" }, "downloads": -1, "filename": "overview_upload-0.9.5.tar.gz", "has_sig": true, "md5_digest": "b97515f76948f3d115cab8b75bcfa4d1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8246, "upload_time": "2017-06-23T14:12:03", "url": "https://files.pythonhosted.org/packages/92/a5/4a3905c0876a63c3c7787783eb3a317c8cfa9c6d0432fac84302568bba3a/overview_upload-0.9.5.tar.gz" } ], "0.9.6": [ { "comment_text": "", "digests": { "md5": "15c698ea3b015b9f26e8abc7affd6e2d", "sha256": "5fa2e5e5cd409d4ae877140587c32974e85b0c09435089dbe6fc3d5abb2f0485" }, "downloads": -1, "filename": "overview_upload-0.9.6.tar.gz", "has_sig": true, "md5_digest": "15c698ea3b015b9f26e8abc7affd6e2d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8565, "upload_time": "2017-06-23T15:24:22", "url": "https://files.pythonhosted.org/packages/ba/d6/ff990b51e0d4dcbff6928632756f3b81f0ee85b90380a7f14080e6c3e94f/overview_upload-0.9.6.tar.gz" } ], "0.9.7": [ { "comment_text": "", "digests": { "md5": "53b8583521f1ad8bada248553457d46f", "sha256": "c6a18a375f593af58aa55eac4ba49be085b8e3a3fdb6d9b180fa0690642b6601" }, "downloads": -1, "filename": "overview_upload-0.9.7.tar.gz", "has_sig": true, "md5_digest": "53b8583521f1ad8bada248553457d46f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9562, "upload_time": "2017-06-23T15:26:59", "url": "https://files.pythonhosted.org/packages/08/a4/6443ba1efd9d3d061db28c222dee9860304ec38982691be2c423b760725d/overview_upload-0.9.7.tar.gz" } ], "0.9.8": [ { "comment_text": "", "digests": { "md5": "289e7fb86e9ceb208b68fb16bd83f828", "sha256": "3e251c080d243387212f758b8a253d2125759c55ee806130c33047b7662742df" }, "downloads": -1, "filename": "overview_upload-0.9.8.tar.gz", "has_sig": true, "md5_digest": "289e7fb86e9ceb208b68fb16bd83f828", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10447, "upload_time": "2017-07-31T20:43:56", "url": "https://files.pythonhosted.org/packages/44/c4/080a5f609434cb7cbd00a83595facb131c50250dfb0b3cafc4ab72615c34/overview_upload-0.9.8.tar.gz" } ], "0.9.9": [ { "comment_text": "", "digests": { "md5": "a317e078dc3c4ebd30beed7a9a2ab777", "sha256": "8828d0b9fb2b348cee454d9ad41b0b138966f5c4c8bc386b45ae7f5289db4137" }, "downloads": -1, "filename": "overview_upload-0.9.9.tar.gz", "has_sig": true, "md5_digest": "a317e078dc3c4ebd30beed7a9a2ab777", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11350, "upload_time": "2017-08-01T14:22:27", "url": "https://files.pythonhosted.org/packages/b0/ca/77632105cacd71b2122e13705a34e2486fd7e7caf6e55b459067d0fdc874/overview_upload-0.9.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "358abb5ea78c2e50a50b988f23888a6f", "sha256": "4575d8e43637f8c9015427594520cc5fd5cf1e573367968fca7d22f2ab907864" }, "downloads": -1, "filename": "overview_upload-0.9.11.tar.gz", "has_sig": true, "md5_digest": "358abb5ea78c2e50a50b988f23888a6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11693, "upload_time": "2017-08-14T13:31:07", "url": "https://files.pythonhosted.org/packages/67/8f/50fd63ea6aaf3d54db0ca2263615c79252052f1dc96ff8f4ed81b22087ca/overview_upload-0.9.11.tar.gz" } ] }