Skip to main content

A Rubik's cube model and solver

Project description

cubeofrubik

PyPi Version Downloads/Month Package Tests Documentation Status

A Rubik's cube model and solver.

Installation

pip install cubeofrubik

Documentation

Find complete documentation on: cubeofrubik.rtfd.io.

Usage:

>>> from cubeofrubik import RubiksCube

>>> cube = RubiksCube()

>>> cube.draw()
            
            
            
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
   🟨 🟨 🟨       
   🟨 🟨 🟨       
   🟨 🟨 🟨       
>>> cube.scramble()
'B′DU′F′DB2FRDBF2URBDB2U′D′L2D'

>>> cube.draw()
   🟧 🟦 🟦       
     🟩       
   🟦 🟨        
🟩 🟥 🟨 🟧 🟥 🟩 🟥 🟥  🟥 🟥 🟨
🟩 🟧  🟦 🟩 🟨 🟧 🟥 🟧 🟦 🟦 🟧
🟧 🟩 🟨 🟩 🟦 🟨 🟥 🟧  🟧 🟩 🟩
   🟥 🟨 🟦       
   🟨 🟨        
     🟦       

>>> cube.solve()
'RB′UR′UB′R2U2R2L2B′U′L2D′L2F2DL2UD′L2'

>>> cube.draw()
            
            
            
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩 🟥 🟥 🟥 🟦 🟦 🟦
   🟨 🟨 🟨       
   🟨 🟨 🟨       
   🟨 🟨 🟨       

>>> cube.move("RUR′U′")
>>> cube.draw()
     🟧       
     🟩       
     🟩       
🟦 🟧 🟧 🟩 🟩 🟨 🟥 🟥  🟦 🟥 🟥
🟧 🟧 🟧 🟩 🟩  🟦 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩  🟥 🟥 🟦 🟦 🟦
   🟨 🟨 🟥       
   🟨 🟨 🟨       
   🟨 🟨 🟨       

>>> cube.is_solvable()
True

>>> cube.is_solved()
False

>>> cube.get_color('F')
'G'

>>> cube.find_position('G', 'Y', 'R')
'UFR'

>>> cube.get_size()
3

>>> cube.set_color('01', 'R')
>>> cube.draw()
     🟧       
     🟩       
     🟩       
🟦 🟧 🟧 🟥 🟩 🟨 🟥 🟥  🟦 🟥 🟥
🟧 🟧 🟧 🟩 🟩  🟦 🟥 🟥 🟦 🟦 🟦
🟧 🟧 🟧 🟩 🟩 🟩  🟥 🟥 🟦 🟦 🟦
   🟨 🟨 🟥       
   🟨 🟨 🟨       
   🟨 🟨 🟨       

>>> cube.is_solvable()
False

License

This cubeofrubik is available under the MIT license. Read the LICENSE file for more info.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cubeofrubik-1.0.0.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distribution

cubeofrubik-1.0.0-py3-none-any.whl (14.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page