README.md

SafetyCulture Exporter

SafetyCulture Exporter is a command-line tool (CLI tool) that’s available to all our Premium and Enterprise customers. You can use the SafetyCulture Exporter to export your data, such as inspections, templates, schedules, and actions, to multiple formats that can be used for business intelligence tools or record keeping.

For instructions on downloading and running the SafetyCulture Exporter, as well as interpreting the data output, please check out our SafetyCulture Exporter documentation.

• SafetyCulture Exporter documentation
• Run the SafetyCulture Exporter
  • Download
  • Configuration
  • Database support
  • Docker support
  • Errors
• Understand the data
  • CSV or SQL?
  • Inspections
  • Inspection items
  • Templates
  • Sites
  • Users
  • Groups
  • Group users
  • Activity log events
  • Schedules
  • Schedule assignees
  • Schedule occurrences
  • Actions
  • Actions assignees
  • Issues

The Python version of the SafetyCulture Exporter is no longer being maintained. We recommend downloading this latest version for faster exporting and additional data sets.

---

Development

To develop the safetyculture-exporter, you'll need the latest version of Golang. When adding new columns in methods that implement Columns() []string, we need to make sure they are added at the end. This way we can preserve the CSV columns in the export files.

NOTE: Consider that every change in PKG directory can affect the Exporter-UI project as well

Testing

Locally you can run go test ./..., this will run all the Unit tests and Integration tests that can be run without an external DB.

SQL Database integration tests can be run by starting the SQL DBs docker-compose up -d and then running make integration-tests.

Note: these tests will be automatically when pushing or opening a pull request against the repository.

To run dockers with local volume: create folder structure ~/docker-volume/mssql then execute: docker-compose -f docker-compose-local-volume.yml up sqlserver

Releasing

To release a new version you need just need to push a new tag to GitHub and goreleaser will do most of the work.

1. Execute make release-dry-run locally to make sure all things go well.
2. Checkout the main branch and pull the latest changes. If you don't you'll tag the wrong commit for release!
3. Create your tag, make sure it follows Semantic Versioning and increments on the latest release
   git tag -a v3.0.0 -m "Initial Public Release".
   Acceptable versions include v3.0.0, v3.0.0-alpha.22, v3.0.0-prealpha.22, v3.0.0-beta.22.
4. Push your tag to GitHub
   git push origin v3.0.0
5. Update the release draft and publish it!
6. Upload the exe file to https://www.virustotal.com and check for false positives