Skip to content

GEOPY-1861: complete package readme and description #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
domfournier merged 3 commits into from
Feb 20, 2025
Merged

GEOPY-1861: complete package readme and description #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3eed400
Add license to README-dev
domfournier Feb 20, 2025
bffed44
Update toml file
domfournier Feb 20, 2025
53b993d
More edits to toml
domfournier Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README-dev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,18 @@ Here is a suggestion for some plugins you can install in PyCharm.

License
^^^^^^^
# TODO: ADD LICENSE TERMS
surface-apps is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

surface-apps is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with surface-apps. If not, see <https://www.gnu.org/licenses/>.


Copyright
Expand Down
16 changes: 7 additions & 9 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,19 @@ maintainers = [
"Dominique Fournier <dominiquef@mirageoscience.com>",
]
homepage = "https://www.mirageoscience.com/mining-industry-software/python-integration/"
readme = "README.rst"
readme = "package.rst"
packages = [
{ include = "surface_apps" },
{ include = "surface_apps-assets" },
]

include = [
"COPYING",
"COPYING.LESSER",
"LICENSE",
"README.rst",
"THIRD_PARTY_SOFTWARE.rst",
{ path = "COPYING" },
{ path = "COPYING.LESSER" },
{ path = "LICENSE" },
{ path = "README.rst" },
{ path = "docs/**/THIRD_PARTY_SOFTWARE.rst" },
]

# TODO: adjust classifiers
keywords = ["geology", "geophysics", "earth sciences"]
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"Intended Audience :: Science/Research",
Expand Down