Quick Start
PlaygroundData Catalogue

GitHub Sync

Streamline your Finter-GitHub sync with this concise .env setup.

Step 1: Setup

  • Repository: Create a GitHub repository.

  • API Token: Obtain a GitHub API token with repo permissions (Settings > Developer settings > Personal access tokens).

Step 2: Configuration

Configure your environment in a .env file:

# .env
FINTER_API_KEY='your_finter_api_key'
GITHUB_REPO_OWNER='your_github_username'
GITHUB_REPO_NAME='your_repository_name'
GITHUB_BRANCH_NAME='your_branch_name'
GITHUB_ACCESS_TOKEN='your_github_api_token'

Step 3: Use with Submission Helper

  • Enable GitHub sync by setting git=True in your submission helper command.

processor.process(start, end, position=True, simulation=True, validation=True, submit=True, git=True)

  • Initial commits are automatic; resubmissions prompt for review.

Step 4: Ignored Items

  • __pycache__ folders and dotfiles (.filename) or dotfolders (/.foldername) are automatically ignored.

Last updated