🚀
Finter
PlaygroundData Catalogue
Quick Start
Quick Start
  • Getting Started with Finter: A Quick Guide
  • Explore Finter
    • Finter Labs (Recommended)
    • Other Ways
      • Google Colab
      • Conda, venv, or Docker
      • Setting Up a .env File (Optional)
  • Framework
    • CM (Content Model)
    • AM (Alpha Model)
    • PM (Portfolio Model)
    • Simulatior
      • Target Volume Limit
    • Finter Cli Submission
      • Validation
      • GitHub Sync
      • [Legacy] JupyterLab Submission
      • [Legacy] Submission
  • MODELING
    • MetaPortfolio
      • Equal weight meta portfolio
      • Fixed weight meta portfolio
      • Risk parity meta portfolio
    • StrategicAssetAllocation
    • DateConverter
    • BuyHoldConverter
  • Supporting Tools
    • FileManager
    • Finter AI (alpha ver.)
    • Data
      • FinHelper
        • filter_unchanged
        • unify_idx
        • shift_fundamental
        • rolling
        • expand_to_gvkeyiid
      • ModelData
      • ID Table
      • ID Converter
      • Quanda Data
    • Evaluator
      • top_n_assets
      • bottom_n_assets
      • compare_with_bm
    • PortfolioAnalyzer
    • Email
Powered by GitBook
On this page
  • Step 1: Setup
  • Step 2: Configuration
  • Step 3: Use with Submission Helper
  • Step 4: Ignored Items

Was this helpful?

Edit on GitHub
  1. Framework
  2. Finter Cli Submission

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 1 year ago

Was this helpful?