Skip to content
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.

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

Fix a couple of typos #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In order to use this tool, you would need to have *either*:
* ArcGIS Desktop, ArcGIS Server or ArcGIS Pro installed (for `arcpy` package). You will be able to run the tool with ArcGIS Desktop/Server Python 2.7 as well as ArcGIS Pro Python 3.5+.
* GDAL (for `ogr` package). This means you will be able to run the tool without having any Esri software installed. However, only file geodatabases are supported for reporting with GDAL.

The code written is a valid Python 2 as well as Python 3 code, so using the tool in both environments is supported. You will need `pandas` and `beatifulSoup` Python packages which can be installed from `pip` if you are ArcGIS Desktop/Server user or using `conda` if you are ArcGIS Pro or Anaconda user. See [Installing Packages](https://packaging.python.org/tutorials/installing-packages/) in the Python documentation (for ArcGIS Desktop users) and [Install a package](https://conda.io/docs/using/pkgs.html#install-a-package) in the Conda documentation (for ArcGIS Pro and Anaconda users) to get help.
The code written is a valid Python 2 as well as Python 3 code, so using the tool in both environments is supported. You will need `pandas` and `beautifulSoup` Python packages which can be installed from `pip` if you are ArcGIS Desktop/Server user or using `conda` if you are ArcGIS Pro or Anaconda user. See [Installing Packages](https://packaging.python.org/tutorials/installing-packages/) in the Python documentation (for ArcGIS Desktop users) and [Install a package](https://conda.io/docs/using/pkgs.html#install-a-package) in the Conda documentation (for ArcGIS Pro and Anaconda users) to get help.

If the package is able to import `arcpy`, then it will use `arcpy` because it provides a more complete view into your geodatabase. The most time is spent in `arcpy` describe and listing functions iterating the datasets and pulling all the relevant information.

Expand Down Expand Up @@ -93,7 +93,7 @@ registrant.domains2html()

### Architecture

This tool uses `arcpy` package (and if you don't have any ArcGIS software installed - `ogr` package) to read properties of geodatabase into Python dictionaries which are used then to construct `pandas` data frames. The data frames are exported into HTML tables (as large strings) using built-in [`pandas.DataFrame.to_html`](https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_html.html) method. To merge all the HTML tables into a single page, `beatifulSoup` package is used. The HTML report page is built using the [Bootstrap 3 Dashboard sample](http://getbootstrap.com/examples/dashboard/#). Some extra functionality is added with the help of [Bootstrap 3 DataTables](https://datatables.net/examples/styling/bootstrap.html) extension. Additional navigation items in the table of contents are added to the HTML page on-the-fly while reading geodatabase tables and feature classes.
This tool uses `arcpy` package (and if you don't have any ArcGIS software installed - `ogr` package) to read properties of geodatabase into Python dictionaries which are used then to construct `pandas` data frames. The data frames are exported into HTML tables (as large strings) using built-in [`pandas.DataFrame.to_html`](https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_html.html) method. To merge all the HTML tables into a single page, `beautifulSoup` package is used. The HTML report page is built using the [Bootstrap 3 Dashboard sample](http://getbootstrap.com/examples/dashboard/#). Some extra functionality is added with the help of [Bootstrap 3 DataTables](https://datatables.net/examples/styling/bootstrap.html) extension. Additional navigation items in the table of contents are added to the HTML page on-the-fly while reading geodatabase tables and feature classes.

### FAQ

Expand Down