GDA Importer is the default project generated by GDA Cookiecutter. GDA Importer contains all the boilerplate you need to create a Python package according to the best-practices of Geometric Data Analytics, Inc.
Project description
GDA Importer
GDA Importer is the default project generated by GDA Cookiecutter. GDA Importer contains all the boilerplate you need to create a Python package according to the best-practices of Geometric Data Analytics, Inc.
See the Documentation at https://geomdata.pages.geomdata.com/gda-importer
Installation
Note Possible conda
Dependencies
Regardless of how you follow the User Installation subsection below, be sure to check if there are any additional, conda
-specific requirements for the package specified in environment.yml
.
If there are any dependencies there other than the cookiecutter defaults, then these may be important to include in a working conda environment wherever you intend to use this package. If there are no additional dependencies there, then this step can be disregarded.
User Installation
If you just want to run the software, do any of these:
- For the official, stable published version, use
pip install gda-importer
Internal users are encouraged to add this dependency to their repository using private_deps.toml
. The section name is used for the pip
call, so it can include optional dependencies too. For this project, the specification would look like:
["gda-importer[testing]"]
gitlab_host = "gitlab.geomdata.com"
gitlab_path = "geomdata/gda-importer"
gitlab_spec = "<current stable release>"
It is strongly encouraged for internal users to choose the <current stable release>
(i.e. vX.Y.Z
, be sure to include the v
in the version!) as specified at the top of this repository's release history. This release can also be found on the "Current Stable Release" badge on the project home page.
If working outside of the private_deps.toml
framework, and you have the necessary https login / ssh keys, the following will also work for installation:
pip install https://gitlab.geomdata.com/geomdata/gda-importer.git@<current stable release>
orpip install git+ssh://git@gitlab.geomdata.com/geomdata/gda-importer.git@<current stable release>
orpip install .
assuming you just cloned the repository to the current directory and checked out the desired tag / branch.- For more advanced or customized development options, as well as developer installation instructions, see CONTRIBUTING.md and DEPENDENCIES.md.
Features
- pip installable
- testing suite with pytest
- documentation with quartodoc
- tests and deployment integrated with gitlab CI/CD
Credits
This package was initialized with cookiecutter and the GDA Cookiecutter
project template.
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
Built Distribution
File details
Details for the file gda_importer-1.0.2.tar.gz
.
File metadata
- Download URL: gda_importer-1.0.2.tar.gz
- Upload date:
- Size: 22.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae4c065c8f959bfc628d2f0bce87d3b85ea21c76c11d68fb7759992d00c48379 |
|
MD5 | 086fb1c919a509eb2efe96eace4f303f |
|
BLAKE2b-256 | d098c37904f6e39f8a10567306e37616853390339adb89749e12714f33dfc388 |
File details
Details for the file gda_importer-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: gda_importer-1.0.2-py3-none-any.whl
- Upload date:
- Size: 21.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 163b718933eaf94aaebc83fc4dd6a4a1df1ea68420ad328958481320f4c5844c |
|
MD5 | f71f44a99b7c5428c82d7ae261c595dc |
|
BLAKE2b-256 | 4365dada8b4f8e2841d792b2a54ec111bd396460665b1551c2d6bedced83b126 |