geography


Namegeography JSON
Version 0.0.81 PyPI version JSON
download
home_page
SummaryGet info about countries and states
upload_time2023-12-13 04:29:10
maintainer
docs_urlNone
authorFrenchFries8854
requires_python
licenseMIT
keywords geography
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Geography Module
# Description

#### This Python module, Geography, provides classes that encapsulate information about geographical entities such as countries, states/provinces, continents, and regions. These classes retrieve various geographical and socioeconomic data attributes.

# Installation

### To use this module, follow these steps:

#### 1. Open a terminal window and type the following command:
#### 2. `pip install geography`
#### 3. Enjoy!

# Usage

## Classes:

####  AustralianState: Represents an Australian state with various attributes such as area, population, GDP, etc.
#### CanadianProvince: Represents a Canadian province with attributes similar to `AustralianState`.
#### Continent: Represents a continent with attributes like total area, population, GDP, etc.
#### Country: Represents a country with a wide range of attributes including area, population, GDP, etc.
#### CountrySimple: A simplified version of `Country` class with essential attributes.
#### USState: Represents a state within the United States with attributes similar to `AustralianState`.
#### USRegion: Represents a region within the United States with attributes similar to `Continent`.

# How to Use:

#### 1. Import the desired class from `Geography`.
#### `import geography`
#### 2. Instantiate the class with a specific identifier (alpha code).
#### `country = geography.fetch_country('USA')`
#### 3. Access various attributes of the instantiated object.
#### `print(country.name)`

# Available subdivisions:

#### Australian States and Territories
#### Canadian Provinces and Territories
#### Continents
#### Countries
#### USA States and Territories
#### USA Regions

# Planned upcoming subdivisions:

#### Brazil States
#### China Provinces
#### Ethiopia Regions
#### France Regions
#### Germany States
#### India States and Territories
#### Japan Prefectures
#### Mexican States
#### Russia Federal Subjects
#### Saudi Arabia Provinces
#### South African Provinces
#### Spain Regions
#### United Arab Emirates - Emirates

# The information you can get:

#### Alpha Code For Subdivisions `(ISO 3166-2)`
#### Alpha-2 Code `(ISO 3166-1 alpha-2)`
#### Alpha-3 Code `(ISO 3166-1 alpha-3)`
#### Area in KM
#### Area in Miles
#### Area Ranking
#### Area Ranking Dictionary
#### Capital
#### Continent
#### Countries in Continent
#### Flag URL
#### GDP
#### GDP Ranking
#### GDP Ranking Dictionary
#### GDP per Capita
#### GDP per Capita Ranking
#### GDP per Capita Ranking Dictionary
#### Largest City
#### Name
#### Region
#### Population
#### Population Ranking
#### Population Ranking Dictionary
#### Population Density in KM
#### Population Density in Miles
#### Population Density Ranking
#### Population Density Ranking Dictionary
#### States in Region
#### Get is State/Province/Territory type. (AST, CPT, SAP, UST)

# Note

### This module relies on external data sources and APIs for retrieving geographical and socioeconomic information. Ensure a stable internet connection for seamless functionality.

### For detailed information on available attributes and methods for each class, refer to the class definitions in the main file.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "geography",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "geography",
    "author": "FrenchFries8854",
    "author_email": "frenchfries8854@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/93/b9/8ecaec1f72ee15e1f94ab8e6e1fbe894986f422613ece667c6b0b4f71710/geography-0.0.81.tar.gz",
    "platform": null,
    "description": "# Geography Module\r\n# Description\r\n\r\n#### This Python module, Geography, provides classes that encapsulate information about geographical entities such as countries, states/provinces, continents, and regions. These classes retrieve various geographical and socioeconomic data attributes.\r\n\r\n# Installation\r\n\r\n### To use this module, follow these steps:\r\n\r\n#### 1. Open a terminal window and type the following command:\r\n#### 2. `pip install geography`\r\n#### 3. Enjoy!\r\n\r\n# Usage\r\n\r\n## Classes:\r\n\r\n####  AustralianState: Represents an Australian state with various attributes such as area, population, GDP, etc.\r\n#### CanadianProvince: Represents a Canadian province with attributes similar to `AustralianState`.\r\n#### Continent: Represents a continent with attributes like total area, population, GDP, etc.\r\n#### Country: Represents a country with a wide range of attributes including area, population, GDP, etc.\r\n#### CountrySimple: A simplified version of `Country` class with essential attributes.\r\n#### USState: Represents a state within the United States with attributes similar to `AustralianState`.\r\n#### USRegion: Represents a region within the United States with attributes similar to `Continent`.\r\n\r\n# How to Use:\r\n\r\n#### 1. Import the desired class from `Geography`.\r\n#### `import geography`\r\n#### 2. Instantiate the class with a specific identifier (alpha code).\r\n#### `country = geography.fetch_country('USA')`\r\n#### 3. Access various attributes of the instantiated object.\r\n#### `print(country.name)`\r\n\r\n# Available subdivisions:\r\n\r\n#### Australian States and Territories\r\n#### Canadian Provinces and Territories\r\n#### Continents\r\n#### Countries\r\n#### USA States and Territories\r\n#### USA Regions\r\n\r\n# Planned upcoming subdivisions:\r\n\r\n#### Brazil States\r\n#### China Provinces\r\n#### Ethiopia Regions\r\n#### France Regions\r\n#### Germany States\r\n#### India States and Territories\r\n#### Japan Prefectures\r\n#### Mexican States\r\n#### Russia Federal Subjects\r\n#### Saudi Arabia Provinces\r\n#### South African Provinces\r\n#### Spain Regions\r\n#### United Arab Emirates - Emirates\r\n\r\n# The information you can get:\r\n\r\n#### Alpha Code For Subdivisions `(ISO 3166-2)`\r\n#### Alpha-2 Code `(ISO 3166-1 alpha-2)`\r\n#### Alpha-3 Code `(ISO 3166-1 alpha-3)`\r\n#### Area in KM\r\n#### Area in Miles\r\n#### Area Ranking\r\n#### Area Ranking Dictionary\r\n#### Capital\r\n#### Continent\r\n#### Countries in Continent\r\n#### Flag URL\r\n#### GDP\r\n#### GDP Ranking\r\n#### GDP Ranking Dictionary\r\n#### GDP per Capita\r\n#### GDP per Capita Ranking\r\n#### GDP per Capita Ranking Dictionary\r\n#### Largest City\r\n#### Name\r\n#### Region\r\n#### Population\r\n#### Population Ranking\r\n#### Population Ranking Dictionary\r\n#### Population Density in KM\r\n#### Population Density in Miles\r\n#### Population Density Ranking\r\n#### Population Density Ranking Dictionary\r\n#### States in Region\r\n#### Get is State/Province/Territory type. (AST, CPT, SAP, UST)\r\n\r\n# Note\r\n\r\n### This module relies on external data sources and APIs for retrieving geographical and socioeconomic information. Ensure a stable internet connection for seamless functionality.\r\n\r\n### For detailed information on available attributes and methods for each class, refer to the class definitions in the main file.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Get info about countries and states",
    "version": "0.0.81",
    "project_urls": null,
    "split_keywords": [
        "geography"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "93b98ecaec1f72ee15e1f94ab8e6e1fbe894986f422613ece667c6b0b4f71710",
                "md5": "56589d05572f8d532746b0c389cc8eb8",
                "sha256": "374528c93e214c5c42f33e77d04337523698e6111b6e7982b56672e110732d0f"
            },
            "downloads": -1,
            "filename": "geography-0.0.81.tar.gz",
            "has_sig": false,
            "md5_digest": "56589d05572f8d532746b0c389cc8eb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 195459,
            "upload_time": "2023-12-13T04:29:10",
            "upload_time_iso_8601": "2023-12-13T04:29:10.404924Z",
            "url": "https://files.pythonhosted.org/packages/93/b9/8ecaec1f72ee15e1f94ab8e6e1fbe894986f422613ece667c6b0b4f71710/geography-0.0.81.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-13 04:29:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "geography"
}
        
Elapsed time: 0.16487s