topic Re: arcapi - Convenient API for arcpy in Python Questions

arcapi - Convenient API for arcpy

FilipKrál — Thu, 27 Feb 2014 21:02:12 GMT

Hello,
Sometimes with arcpy I feel that to do little you need to write a lot. To make my life easier, I have written and documented a collection of functions, which are available as 'arcapi' on github:

https://github.com/NERC-CEH/arcapi

You are more than welcome to use it and, even better, contribute - by adding new code or just providing feedback and ideas.

To point out only a few functions: 'plot' makes a scatter plot, 'chart' makes a quick map, 'head' prints first rows of a table into the console... the idea is to do a lot with simple function calls.
Please see the README.md and arcpy_tutorial.py for more details.

I'm sure many of you guys have similar personal libraries, or you wish there was an easy way of coding something.
Do you... do you want to share?

Filip.

Re: arcapi - Convenient API for arcpy

ClintDow — Fri, 28 Feb 2014 20:51:47 GMT

Nice, I'm interested. I'll be checking this out.. sometime.. when I have some spare hours.

Re: arcapi - Convenient API for arcpy

TreyCundall — Wed, 05 Mar 2014 18:34:21 GMT

Very cool!

I actually just started working on a similar codebase with a GIS professor up in Alaska but you're way ahead of us. I'm starting to play around with your API and it seems like a great starting point for creating some tools to make sense of the chaos that is arcpy.

I'm also running 10.2.1 so I can help test to make sure everything works in that version too (everything should, right? but you never know).

Thanks for sharing this.

Re: arcapi - Convenient API for arcpy

ChrisSnyder — Wed, 05 Mar 2014 20:00:01 GMT

Beautiful! I built something similar (but definitely not as fancy) a while back... like your arcapi, my lmpy basically made python/arcpy more of a command prompt sort of interface (for those that like that sort of thing).

Hope to contribute to your project sometime... if I ever have time again to do that sort of thing :rolleyes:

Good job Filip and Caleb!

Re: arcapi - Convenient API for arcpy

Anonymous User — Wed, 05 Mar 2014 20:49:13 GMT

Beautiful! I built something similar (but definitely not as fancy) a while back... like your arcapi, my lmpy basically made python/arcpy more of a command prompt sort of interface (for those that like that sort of thing).

Hope to contribute to your project sometime... if I ever have time again to do that sort of thing :rolleyes:

Good job Filip and Caleb!

Chris,

You should definitely contribute....Much of my 'bag of tricks' has been inspired by some of your code samples...As for arcapi, I can't take much credit. Filip is the one who got it off the ground and built 98% of it. I just added some of the functions at the bottom (remap and raster processing stuff). I still need to provide some testing samples though.

I need to browse through my library and hope to add more in the future. This is a great idea and I encourage others to contribute as well!

Re: arcapi - Convenient API for arcpy

ChrisSnyder — Sat, 11 Dec 2021 13:10:17 GMT

I guess this shows my ignorance of the internet today, but if we have code/ideas how would it be best to communicate that with you fellows? I'm sure there's some fancy github way of doing all that... Sadly I'm pretty ignorant of that and stuck in the internet of like 2003 for some reason.

Looks like these functions (and frankly, much better/fancier ones!) are already in your arcapi library, but for what it's worth comparing independent invention and all that, here's a few of mine I use all the time... I'd love to contribute some time to ideas/code sometime. Send me an email: chris.snyder( at ) dnr.wa.gov

def listFields(inputTable, wildCard = "", fieldType = ""):
    """Lists fields (and selected properties) for inputTable"""
    fieldList = arcpy.ListFields(inputTable, wildCard, fieldType)
    #FORMATTING INFO: NAME = 50 spaces, TYPE = 15 spaces, LENGTH = 15 spaces, SCALE = 15 spaces, PRECISION = 15 spaces 
    print "NAME                                              " + "TYPE           " + "LENGTH         " + "SCALE          " + "PRECISION      "
    print "-" * 100
    for field in fieldList:
        print str(field.name)[0:50] + " "*(50-len(field.name)) \
                  + str(field.type)[0:15] + " "*(15-len(str(field.type))) \
                  + str(field.length)[0:15] + " "*(15-len(str(field.length))) \
                  + str(field.scale)[0:15] + " "*(15-len(str(field.scale))) \
                  + str(field.precision)[0:15] + " "*(15-len(str(field.precision)))

def listRecs(inputTable, numberOfRecordsToList = 25, whereClause = ""):
    """Lists field names and corresponding field values in inputTable"""
    fieldNamesList = [f.name for f in arcpy.ListFields(inputTable)]
    rowCount = 1
    recordCount = int(arcpy.GetCount_management(inputTable).getOutput(0))
    if int(numberOfRecordsToList) > recordCount:
        numberOfRecordsToList = recordCount
    searchRows = arcpy.da.SearchCursor(inputTable, ["*"], whereClause)
    searchRow = searchRows.next()
    while rowCount <= int(numberOfRecordsToList):
        print "RECORD #" + str(rowCount)
        print "-" * 50
        for fieldName in fieldNamesList:
            try:
                print fieldName + ": " + str(searchRow[fieldNamesList.index(fieldName)])
            except:
                print fieldName + ": !?!" 
        print ""
        print ""
        rowCount = rowCount + 1
        searchRow = searchRows.next()
    del searchRow, searchRows
    print ""
    print ""
    print "LISTED " + str(numberOfRecordsToList) + " RECORDS"

Re: arcapi - Convenient API for arcpy

FilipKrál — Wed, 05 Mar 2014 22:30:42 GMT

Hello and thanks for such a great support!
I am so glad to see that you are on board with this and that some of you have already contributed. Great stuff!

The best way to contribute code is exactly how Caleb did - using github. That is of course if you are already familiar with github (or have time and will to explore it).

I totally understand you might not want to (or don't have time to) learn about github. In that case we can:

post ideas and code into this thread

post links to other discussions, blog posts, sites etc. that have some specific and (almost) ready to use code

send emails to contact( at )filipkral.com, although I would prefer github and this thread to keep it open for everyone.

In any case, I believe it is clear (and I'll clarify this in the README) that by contributing code to arcapi you are releasing the code under the Lesser General Public License v3.

To point out just 3 things I think are awesome about github:

It is a version control system which makes managing changes easy.

It allows discussions about very specific bits of code.

It is quite transparent who contributed and to what extent.

Last thing to say at this point: it seems I'm able to review any new contributions about once a weak. If I don't react straight away, it's because I don't want to rush the code too much, but eventually I'll reply. So Chris, I'll consider your functions soon, thanks.

Keep it coming!
Filip.

Re: arcapi - Convenient API for arcpy

ChrisSnyder — Wed, 05 Mar 2014 23:15:29 GMT

Okay I watched a YouTube thing, so I now should theoretically have enough info to submit stuff directly via github myself... I'll get an account soon!

BTW: Those functions I showed probably shouldn't be included since I think you already have some that do very similar things in your arcapi... Just demonstrating that many of us (at least me) have created similar arcpy-based libraries... although as far as I know, not shared/created them as a cooperative process. I've been meaning to update my stuff for a long time, which is really a hodgepodge... hope to have some time in a few weeks. On a similar note, I've always thought it'd be cool to have a single "collaboratively built" toolbox crammed full of all sorts of neat geoprocesisng script tools.... Kind of like a analysis tools for analysts sort of thing. Wonder if that could work via github at some point too?

Anyway - Good job!!!

Re: arcapi - Convenient API for arcpy

ClintDow — Thu, 06 Mar 2014 13:55:45 GMT

For anyone interested in learning how to use git/github, check out the free course at:
https://www.coursera.org/course/datascitoolbox

The next session begins in April.

Re: arcapi - Convenient API for arcpy

MathewCoyle — Wed, 12 Mar 2014 13:58:46 GMT

Very nice, I'll see if there is anything I can contribute that isn't already included. Just to note however, try to ensure we follow PEP8 and Python 3 forward compatibility when possible.

Re: arcapi - Convenient API for arcpy

justinperez — Wed, 09 Apr 2014 20:18:10 GMT

I have similar project. Though I am wanting to learn/do more class stuff. So I have the makings of a class library at https://github.com/perezjust/ageopy

I still need to go through other libraries to be inspired by their patterns.

I hope to one day get this organized for the arcpy stuff and then have it also wrap gdal/ogr and possibly qgis mapping stuff.

Lofty goals...I know!

Re: arcapi - Convenient API for arcpy

FilipKrál — Thu, 10 Apr 2014 18:50:55 GMT

Good effort Justin, I think I see where you are coming from and where you want to go.

So far arcapi has just functions rather than classes because functions are easier to manage at this stage. I think for what arcapi does, functions will be suitable quite some time into the future, but having an object-oriented library is a good idea.

Feel free to borrow from and contribute to arcapi!

Filip.